Contributing

Pull requests

Follow this process if you'd like your work considered for inclusion in the project:

1. Fork the project, clone your fork, and configure the remotes:

   git clone https://github.com/<your-username>/paramount
   cd paramount
   git remote add upstream https://github.com/WeTrustPlatform/paramount

2. If you cloned a while ago, get the latest changes from upstream:

   git checkout master
   git pull upstream master

3. Install/update dependencies:

   yarn install

4. Create a new topic branch (off the master branch) to contain your feature, change, or fix:

   git checkout -b <topic-branch-name>

5. Locally merge (or rebase) the upstream development branch into your topic branch:

   git pull [--rebase] upstream master

6. Push your topic branch up to your fork:

   git push origin <topic-branch-name>

7. Open a Pull Request with a clear title and description. If screenshot can be included, please attach one.

Development for React Native

N/A

Development for React Web

The development of components on web happen on Storybook

yarn dev

Storybook will then be available at http://localhost:6006.

Development for Docs

The development of components on web happen on the documentation site

yarn docs

Docz will then be available at http://localhost:3000.

Running Tests

You can run unit tests with like so:

yarn test

If you are confident in your changes, update snapshots

yarn test -u