Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 3.9 KB

CONTRIBUTING.md

File metadata and controls

112 lines (76 loc) · 3.9 KB
Raw

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Contributing to the docs

Documentation uses Sphinx and reStructuredText. Source inside the docs directory.

  1. Go to the docs directory

  2. Run pipenv install to setup Python environemnt (requires Python 3.6). If you encounter ValueError('unknown locale: %s' % localename), run export LC_ALL=en_US.UTF-8 && export LANG=en_US.UTF-8 and try again.

  3. Run pipenv run make livehtml to build the docs, watch for changes and preview documentation locally at http://127.0.0.1:8000.

  4. It's also possible to run pipenv run make html for single build. Incremental builds are much faster than the first one as only changed files are built.

Contributing the code

This project uses yarn package manager. Please follow official docs to install it.

Setup local environment

  1. Install node

    You can download node from official webite, install it using package managers (brew on MacOS), or uing node version managers (nvm). Make sure the node version includes internationalization support (full-icu).

    An example of installing with nvm:

    # install nvm
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash

# This will force nvm to build from source with full icu. By default, nvm provides node with limited icu
nvm install -s v8.11.4 --with-intl=full-icu

  2. Clone project

    git clone https://github.com/lingui/js-lingui.git
cd js-lingui

  3. Install development packages. This project uses yarn workspaces instead of Lerna, so running yarn installs all development packages and also dependencies for all workspaces (inside packages/*).

    yarn

  4. Run tests

    # Watch mode
yarn watch

# Single run
yarn test

    NOTE: if you are using an IDE to run test make sure to use the right Jest config. For unit tests use -c scripts/jest/config.unit.js. Integration tests use build packages (created using yarn release:build) and config -c scripts/jest/config.integration.js. See package.json for more info.

Using development version in your project

After you successfully fix a bug or add a new feature, you most probably want to test it in your project as soon as possible.

jsLingui uses yalc to run integration tests on production build. You can do the same in your project:

  1. Build all packages:

    yarn release:build

  2. Packages are inside build/packages directory. First, run yalc publish in each of them and then run yalc link <package> for each @lingui/ dependency in your project. Now your project uses your local version of jsLingui.

  3. After you make some changes, you need to run yarn release:build only.

Finalize changes

Please make sure that all tests pass and linter doesn't report any error before submitting a PR (Don't worry though! If you can't figure out the problem, create a PR anyway and we'll help you).

  • yarn lint - Linting
  • yarn test - Quick test suite (sufficient)
  • yarn release:test - Full test suite (recommended)

yarn release:test builds all packages, simulates creating packages for NPM, runs unit tests and finally runs integration tests using production build.

Now you can create PR and let CI service do their work!

If you need any help, just raise an issue or submit an working draft of PR.