docs: update contributing
parent
9d1b6a81ee
commit
f1e672470c
|
@ -19,11 +19,24 @@ When fixing a bug it is fine to submit a pull request right away.
|
||||||
|
|
||||||
Steps to be performed to submit a pull request:
|
Steps to be performed to submit a pull request:
|
||||||
|
|
||||||
1. Fork the repository and create your branch from `develop`.
|
1. Fork the repository.
|
||||||
2. If you have fixed a bug or added code that should be tested, add tests.
|
2. Clone the repository.
|
||||||
3. Click `Window > Generals > Test Runner` to test
|
3. Checkout `develop` branch.
|
||||||
4. Commit with a massage based on [Angular Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153).
|
4. Develop the package.
|
||||||
5. Fill out the description, link any related issues and submit your pull request.
|
5. Test the package with the test runner (`Window > Generals > Test Runner`).
|
||||||
|
6. Commit with a message based
|
||||||
|
on [Angular Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153) as follows:
|
||||||
|
|
||||||
|
- `fix:` fix a bug
|
||||||
|
- `feat:` new feature
|
||||||
|
- `docs:` changes only in documentation
|
||||||
|
- `style:` changes only in formatting, white-space, etc
|
||||||
|
- `refactor:` changes only in code structure (extract method, rename variable, move method, etc)
|
||||||
|
- `perf:` changes only in code performance
|
||||||
|
- `test:` add or update tests
|
||||||
|
- `chore:` changes to the build process or auxiliary tools and libraries such as documentation generation
|
||||||
|
|
||||||
|
7. Create a pull request on GitHub. Fill out the description, link any related issues and submit your pull request.
|
||||||
|
|
||||||
#### License
|
#### License
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue