Skip to content

Commit 524dc86

Browse files
Update contributing and pull request template (#130)
1 parent efd8994 commit 524dc86

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,13 @@
22

33
*Description of changes:*
44

5+
## Merge Checklist
6+
7+
_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request._
8+
9+
- [ ] I have read the [CONTRIBUTING](https://github.com/aws/sagemaker-python-sdk/blob/master/CONTRIBUTING.md) doc
10+
- [ ] I have added tests that prove my fix is effective or that my feature works (if appropriate)
11+
- [ ] I have updated the [changelog](https://github.com/aws/sagemaker-python-sdk/blob/master/CHANGELOG.rst) with a description of my changes (if appropriate)
12+
- [ ] I have updated any necessary [documentation](https://github.com/aws/sagemaker-python-sdk/blob/master/README.rst) (if appropriate)
513

614
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

CONTRIBUTING.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ reported the issue. Please try to include as much information as you can. Detail
1717
* A reproducible test case or series of steps
1818
* The version of our code being used
1919
* Any modifications you've made relevant to the bug
20-
* Anything unusual about your environment or deployment
20+
* A description of your environment or deployment
2121

2222

2323
## Contributing via Pull Requests
@@ -31,10 +31,12 @@ To send us a pull request, please:
3131

3232
1. Fork the repository.
3333
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
34-
3. Ensure local tests pass.
35-
4. Commit to your fork using clear commit messages.
36-
5. Send us a pull request, answering any default questions in the pull request interface.
37-
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
34+
3. Include unit tests when you contribute new features or make bug fixes, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost.
35+
4. Ensure local tests pass.
36+
5. Update the [changelog](https://github.com/aws/sagemaker-python-sdk/blob/master/CHANGELOG.rst) with a description of your changes for any code contribution.
37+
6. Commit to your fork using [clear and imperative commit messages](https://chris.beams.io/posts/git-commit/).
38+
7. Send us a pull request, answering any default questions in the pull request interface.
39+
8. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
3840

3941
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
4042
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).

0 commit comments

Comments
 (0)