Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (30 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 1.77 KB
Raw

Contributing

By contributing to Stapp, you agree to abide by the code of conduct.

Instructions

These steps will guide you through contributing to this project:

  • Fork the repo.
  • Checkout the develop branch.
  • Install dependencies with npm run bootstrap command.
git clone https://github.com/TinkoffCreditSystems/stapp
cd stapp
npm install
  • Create a new branch from the develop branch.
  • Make your changes. Make sure the commands npm run build and npm run test are passing.

Updating README

  • README.md in the root is copied automatically from the ./docs/ directory, so if you plan to make changes, make them in the ./docs/README.md file.

Committing

Please, commit changes with npm run cz. This command will run commitizen, which will protect you against commit message pain. You may also install commitizen globally and commit with git cz.

You'll be asked about the changes scope. Please, select among the following:

  • core - any feature and tests changes related to the core stapp package
  • validate - same for stapp-validate package
  • loaders - same for stapp-loaders package
  • formbase- same for stapp-formbase package
  • persist - same for stapp-persist package
  • react - same for stapp-react package
  • rxjs - same for stapp-rxjs package
  • select - same for stapp-select package
  • root - changes related to the root of this project
  • use all or leave empty when your changes are related to every single package

Finally send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). Make sure all of your commits are atomic (one feature per commit).