darkkirb/harness-drone
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update pull_request_template.md

Browse source 
Update to wording
This commit is contained in:
Marie Antons 2021-07-20 10:52:33 -05:00 committed by GitHub
parent efc071c712
commit 7ae6bb2089
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
.github/pull_request_template.md vendored
View file

@ -1,26 +1,27 @@
## Commit Checklist
Thank you for creating a pull request !! to help us review / merge this can you make sure that your PR adheres as much as possible to the following.
Thank you for creating a pull request! To help us review / merge this can you make sure that your PR adheres as much as possible to the following.
### The Basics
- my commit is a single logical unit of work, only use multiple commits if doing different tasks
- my commit does not include commented out code or unneeded files
- Commit is a single logical unit of work, only use multiple commits if doing different tasks
- Commit does not include commented out code or unneeded files
- rebase of main branch
### The Content
- my commit includes tests for the bug I fixed or feature I added
- my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality
- my code passes existing test suites
- Must include testing for bug or feature
- Must include appropriate documentation changes if it is introducing a new feature or changing existing functionality
- Must pass existing test suites
### The Commit Message
- short description is meaningful
- uses the imperative, present tense: "change", not "changed" or "changes"
- includes motivation for the change, and contrasts its implementation with the previous behavior
- Short meaningful description (ex: remove deprecated steps)
- Uses the imperative, present tense: "change", not "changed" or "changes"
- Includes motivation for the change, and contrasts its implementation with the previous behavior
### The Pull Request
- why, what is the reason for this change
- example usage of the failure for a bug, or configuration and expected output for a feature
- What is the reason for this change
- Example usage of the failure for a bug, or configuration and expected output for a feature
- Steps to test the change