Contributing Guidelines

Jump to bottom

Marco Vanali edited this page Jan 24, 2022 · 2 revisions

Check the repository of the project on github.

Fork the repo.
Clone the repo locally.

git clone git@github.com:<your-username>/newskit.git
cd newskit
yarn install

Checkout to develop branch.

git checkout develop

Check the existing issues tab.
Branch out from develop branch using the following naming convention: <type>/<issue-id>-<name-describing-the-change>, where type is fix for bugfix, feat for feature and docs for documentation.

git checkout -b <type>/<issue-id>-<name-describing-the-change>

When you're ready with your contribution run the tests locally.

yarn test:unit:run -u

Commit and push.

git commit
git push origin <issue-id>-<name-describing-the-change>

Open a pull request.
Attent to feedback.
Success. Thank you.