diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..078f2cf --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ +**Please check if the PR fulfills these requirements** + +- [ ] The commit(s) message(s) follows our [guidelines](https://github.com/toutpt/angular-osm/blob/master/CONTRIBUTING.md#commit-message-format) +- [ ] Tests for the changes have been added (for bug fixes / features) +- [ ] Docs have been added / updated (for bug fixes / features) + +**What is the current behavior?** (You can also link to an open issue here) + + + +**What is the new behavior?** + + + +**Does this PR introduce a breaking change?** + +- [ ] Yes +- [ ] No + +If this PR contains a breaking change, please describe the impact and migration path for existing applications: ... + + +**Other information**: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..34882de --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,85 @@ +# Contributing to the project + +:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: + +Here are the guidelines we'd like you to follow: + +- [Pull Requests](#pullrequest) +- [Commit Message Guidelines](#commit) + +## Github Pull Requests + +QA: Quality Assurance +PR: Pull Request +CI: Continuous Integration (Travis) + +Here is the workflow for pull requests we are using. + +1. Submit your pull request. + => the CI should kick tests so you will have feedback about the different QA +2. If any issues are marked on the PR by CI please fix them. No broken PR will be reviewed. +3. Once the quality checks are OK, and you need your PR to be reviewed you must use the label **Need review**. If your PR is still a work in progress, do not use any label but this means no review will be performed. +4. The components owners will then identify who is going to do the review and then assign it. The reviewer will recieve an automatic mail notification. +6. We use the new review system of github so you will know if the reviewer request changes, approve it or just add some comments. +7. if any changes are requested please fix them and then once you are ready request a new review by ping the reviewer throw github + +## Git Commit Guidelines + +We have very precise rules over how our git commit messages can be formatted. This leads to **more +readable messages** that are easy to follow when looking through the **project history**. + +### Commit Message Format +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +``` +(): + + + +