Skip to content

Commit 1c34da4

Browse files
rashidspmikeproeng37
authored andcommitted
chore(contrib): Add PR template and commit message guidelines. (#148)
1 parent af38afb commit 1c34da4

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

.github/pull_request_template.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Summary
2+
-------
3+
4+
- The “what”; a concise description of each logical change
5+
- Another change
6+
7+
The “why”, or other context.
8+
9+
Test plan
10+
---------
11+
12+
Issues
13+
------
14+
15+
- “THING-1234” or “Fixes #123”

CONTRIBUTING.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,16 @@ read the guidelines below for information on submitting your code.
99
Development process
1010
-------------------
1111

12-
1. Create a branch off of ``master``:
13-
``git checkout -b YOUR_NAME/branch_name``.
14-
2. Commit your changes. Make sure to add tests!
15-
3. Lint your changes before submitting: ``pep8 YOUR_CHANGED_FILES.py``.
16-
4. ``git push`` your changes to GitHub.
17-
5. Make sure that all unit tests are passing and that there are no merge
12+
1. Fork the repository and create your branch from master.
13+
2. Please follow the `commit message guidelines`_ for each commit message.
14+
3. Make sure to add tests!
15+
4. Run ``pep8`` to ensure there are no lint errors.
16+
5. ``git push`` your changes to GitHub.
17+
6. Open a PR from your fork into the master branch of the original repo.
18+
7. Make sure that all unit tests are passing and that there are no merge
1819
conflicts between your branch and ``master``.
19-
6. Open a pull request from ``YOUR_NAME/branch_name`` to ``master``.
20-
7. A repository maintainer will review your pull request and, if all
20+
8. Open a pull request from ``YOUR_NAME/branch_name`` to ``master``.
21+
9. A repository maintainer will review your pull request and, if all
2122
goes well, squash and merge it!
2223

2324
Pull request acceptance criteria
@@ -76,5 +77,6 @@ If you have questions, please contact developers@optimizely.com.
7677

7778
.. _Contributor License Agreement (CLA): https://docs.google.com/a/optimizely.com/forms/d/e/1FAIpQLSf9cbouWptIpMgukAKZZOIAhafvjFCV8hS00XJLWQnWDFtwtA/viewform
7879
.. _README: README.rst
80+
.. _commit message guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines
7981
.. _deviations: https://github.com/optimizely/python-sdk/blob/master/tox.ini
80-
.. _Apache License v2.0: http://www.apache.org/licenses/LICENSE-2.0
82+
.. _Apache License v2.0: http://www.apache.org/licenses/LICENSE-2.0

0 commit comments

Comments
 (0)