Skip to content

Commit f0b45d5

Browse files
authored
chore(contrib): Add PR template and commit message guidelines. (#183)
1 parent 615d9da commit f0b45d5

File tree

2 files changed

+19
-7
lines changed

2 files changed

+19
-7
lines changed

.github/pull_request_template.md

Lines changed: 10 additions & 0 deletions
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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ We welcome contributions and feedback! All contributors must sign our [Contribut
44

55
## Development process
66

7-
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 `npm run lint` to ensure there are no lint errors.
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!
7+
1. Fork the repository and create your branch from master.
8+
2. Please follow the [commit message guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines) for each commit message.
9+
3. Make sure to add tests!
10+
4. Run `npm run lint` to ensure there are no lint errors.
11+
5. `git push` your changes to GitHub.
12+
6. Open a PR from your fork into the master branch of the original repo
13+
7. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`.
14+
8. Open a pull request from `YOUR_NAME/branch_name` to `master`.
15+
9. A repository maintainer will review your pull request and, if all goes well, squash and merge it!
1416

1517
## Pull request acceptance criteria
1618

0 commit comments

Comments
 (0)