Unverified Commit f144eae5 authored by Tamika Tannis's avatar Tamika Tannis Committed by GitHub

Update PULL_REQUEST_TEMPLATE.md (#125)

* Update PULL_REQUEST_TEMPLATE.md

* Tweaked some text
parent ec6ed234
Make sure you have checked **all** steps below. ### Summary of Changes
### Title _Include a summary of changes then remove this line_
- [ ] My PR Title addresses the issue accurately and concisely.
- Example: "Updates the version of Flask to v1.0.2"
- In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
### Description
- [ ] Here are some details about my PR, including screenshots of any UI changes:
### Tests ### Tests
- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason: _What tests did you add or modify and why? If no tests were added or modified, explain why. Remove this line_
### Commits
- [ ] I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Documentation ### Documentation
- [ ] In case of new functionality, my PR adds documentation that describes how to use it. _What documentation did you add or modify and why? Add any relevant links then remove this line_
- All the public functions and the classes in the PR contain docstrings that explain what it does
### Code Quality & Coverage
- [ ] Passes `make test` ### CheckList
\ No newline at end of file Make sure you have checked **all** steps below to ensure a timely review.
- [ ] PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2"
- In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
- [ ] PR includes a summary of changes, including screenshots of any UI changes.
- [ ] PR adds unit tests, updates existing unit tests, __OR__ documents why no test additions or modifications are needed.
- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- All the public python functions and the classes in the PR contain docstrings that explain what it does
- [ ] PR passes all tests documented in the [developer guide](https://github.com/lyft/amundsenfrontendlibrary/blob/master/docs/developer_guide.md#testing)
- [ ] I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment