By contributing to Stapp, you agree to abide by the code of conduct.
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
andnpm run test
are passing.
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.
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 corestapp
packagevalidate
- same forstapp-validate
packageloaders
- same forstapp-loaders
packageformbase
- same forstapp-formbase
packagepersist
- same forstapp-persist
packagereact
- same forstapp-react
packagerxjs
- same forstapp-rxjs
packageselect
- same forstapp-select
packageroot
- 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).