Skip to content

Latest commit

 

History

History
82 lines (57 loc) · 1.82 KB

development.md

File metadata and controls

82 lines (57 loc) · 1.82 KB
Raw

Contribute

Any contribution is welcome. Just follow those guidelines:

  1. If you are unsure, open a ticket before working on anything.
  2. Fork and clone the project
  3. Create a branch git checkout -b feature/my-feature (or hotfix). If you want to work on multiple bugs or improvements, do so in multiple branches and PRs. It almost always complicated things to mix unrelated changes.
  4. Push the code to your fork
  5. Write tests and documentation. I won't merge a PR without it!
  6. Make a pull request from your new branch
  7. Wait, I am usually pretty fast to merge PRs :)

Thanks a lot to all the previous contributors.

Setup

git clone [email protected]:<your-username>/i18next-parser.git
cd i18next-parser
yarn

Development

The code is written using the latest ES6 features. For the cli to run on older node version, it is compiled with Babel. You can run the compiler in watch mode and let it in the background:

yarn watch

Don't forget to commit the compiled files.

Tests

Make sure the tests pass:

yarn test

To test the CLI:

yarn link
cd test
i18next manual/**/*.html  -c i18next-parser.config.js
i18next manual/**/*.html  -c i18next-parser.config.js --fail-on-warnings
i18next manual/**/*.{js,jsx} --fail-on-warnings

To test gulp:

yarn global add gulp@next
cd test
gulp i18next

To test broccoli:

yarn global add broccoli-cli
cd test
rm -rf dist && broccoli build dist

Deploy

  • yarn build
  • update package.json version
  • create commit and add version tag
  • npm publish

0.x vs 1.x

1.x is a major release. It is not backward compatible. There are two separate branches:

  • master for 1.x
  • 0.x.x for the old version

I will not maintain the old version but will welcome bug fixes as PRs.