Skip to content

Commit e8286be

Browse files
mnoman09thomaszurkan-optimizely
authored andcommitted
chore(contrib): Add PR template and commit message guidelines. (#231)
1 parent d5d9cd3 commit e8286be

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

.github/pull_request_template.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Summary
2+
- The "what"; a concise description of each logical change
3+
- Another change
4+
5+
The "why", or other context.
6+
7+
## Test plan
8+
9+
## Issues
10+
- "THING-1234" or "Fixes #123"

CONTRIBUTING.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@ We welcome contributions and feedback! All contributors must sign our [Contribut
55
## Development process
66

77
1. Create a branch off of `master`: `git checkout -b YOUR_NAME/branch_name`.
8-
2. Commit your changes. Make sure to add tests!
9-
3. Run `./gradlew clean check` to automatically catch potential bugs.
10-
4. `git push` your changes to GitHub.
11-
5. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`.
12-
6. Open a pull request from `YOUR_NAME/branch_name` to `master`.
13-
7. A repository maintainer will review your pull request and, if all goes well, squash and merge it!
8+
2. Commit your changes. We follow the [commit message guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines) from Angular.
9+
3. Make sure to add tests!
10+
4. Run `./gradlew clean check` to automatically catch potential bugs.
11+
5. `git push` your changes to GitHub.
12+
6. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`.
13+
7. Open a pull request from `YOUR_NAME/branch_name` to `master`.
14+
8. A repository maintainer will review your pull request and, if all goes well, squash and merge it!
1415

1516
## Pull request acceptance criteria
1617

0 commit comments

Comments
 (0)