Skip to content

Commit

Permalink
clarify contributing tips; bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
siddharthvp committed Apr 17, 2021
1 parent 8e47c56 commit d1aaf60
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is intended to be the "core" repository for [Twinkle](https://en.wikipedia.org/wiki/Wikipedia:Twinkle) using which Twinkle installations for different wikis can be created (for example: [twinkle-enwiki](https://github.com/wikimedia-gadgets/twinkle-starter))

The [twinkle-starter repository](https://github.com/wikimedia-gadgets/twinkle-starter) provides a template using which a new Twinkle installation can be started off easily. Each twinkle installation relies on twinkle-core as an npm dependency.
The [twinkle-starter repository](https://github.com/wikimedia-gadgets/twinkle-starter) provides a template using which a new Twinkle installation can be started off easily. Each twinkle installation relies on twinkle-core as an npm dependency. Please refer to the README of twinkle-starter for instructions on setting up twinkle for a new wiki.

[![Download stats](https://nodei.co/npm/twinkle-core.png?downloads=true&downloadRank=true)](https://nodei.co/npm/twinkle-core/)

Expand All @@ -13,9 +13,8 @@ Twinkle-core uses [orange-i18n](https://github.com/wikimedia-gadgets/orange-i18n
## Contributing

- Set up an IDE or code editor to work with JS/TS. Popular choices include Visual Studio Code or one of the JetBrains IDEs if you have a licence (JetBrains offers free licenses to [MediaWiki contributors](https://www.mediawiki.org/wiki/JetBrains_IDEs) and [students](https://www.jetbrains.com/community/education/#students)). If you are a command line veteran, check out [TypeScript for Vim](https://www.vimfromscratch.com/articles/setting-up-vim-for-typescript/) or [emacs](https://wikemacs.org/wiki/TypeScript)!
- See [the integrated development workflow](https://github.com/wikimedia/wvui#integrated-development-workflow) to work on twinkle-core while developing or testing a localised twinkle installation. The linked resource is from another repo – replace "WVUI" with "twinkle-core".
- This method doesn't appear to work reliably. If that's the case, please just clone the two repos and import the core from the other.
- Please see [twinkle-enwiki](https://github.com/wikimedia-gadgets/twinkle-starter) for more detailed development/debugging guidelines.
- Work on twinkle-core is usually done while developing or testing a localised twinkle installation (such as [twinkle-enwiki](https://github.com/wikimedia-gadgets/twinkle-enwiki)). In twinkle-enwiki, all imports from twinkle-core are used through the gateway file [core.ts file](https://github.com/wikimedia-gadgets/twinkle-enwiki/blob/master/src/core.ts). Change `export * from 'twinkle-core';`there to `export * from '../../twinkle-core/src/index';`. (Assuming that you have twinkle-core and twinkle-enwiki cloned as sibling directories).
- Some other projects such as WVUI follow a somewhat [more systematic workflow](https://github.com/wikimedia/wvui#integrated-development-workflow). You can also try this method though it wasn't working reliably for me.
- Try to ensure all documentation comments align with the [TSDoc standard](https://tsdoc.org/), and [what Typedoc supports](https://typedoc.org/guides/doccomments/).

## Workflows
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"title": "Twinkle core",
"name": "twinkle-core",
"version": "3.0.2-beta",
"version": "3.0.3-beta",
"repository": {
"type": "git",
"url": "https://github.com/wikimedia-gadgets/twinkle-core"
Expand Down

0 comments on commit d1aaf60

Please sign in to comment.