-
Notifications
You must be signed in to change notification settings - Fork 567
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: add new PR template * docs: update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Steve Winton <[email protected]> Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Steve Winton <[email protected]> Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Steve Winton <[email protected]> --------- Co-authored-by: Steve Winton <[email protected]>
- Loading branch information
1 parent
2cf8ac3
commit 3a5ac28
Showing
1 changed file
with
48 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,61 @@ | ||
| - [ ] Follows [CONTRIBUTING](https://github.com/snyk/snyk/blob/master/CONTRIBUTING.md) rules | ||
| ## Pull Request Submission | ||
|
|
||
| #### What does this PR do? | ||
| Please check the boxes once done. | ||
|
|
||
| The pull request must: | ||
|
|
||
| #### Where should the reviewer start? | ||
| - **Reviewer Documentation** | ||
| - [ ] follow [CONTRIBUTING](https://github.com/snyk/cli/blob/master/CONTRIBUTING.md) rules | ||
| - [ ] be accompanied by a detailed description of the changes | ||
| - [ ] contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies. | ||
| - [ ] highlight breaking API if applicable | ||
| - [ ] contain a link to the automatic tests that cover the updated functionality. | ||
| - [ ] contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author. | ||
| - [ ] link to the link to the PR for the User-facing documentation | ||
| - **User facing Documentation** | ||
| - [ ] update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here | ||
| - [ ] ensure that the message of the final single commit is descriptive and prefixed with either `feat:` or `fix:` , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes. | ||
| - **Testing** | ||
| - [ ] Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR. | ||
|
|
||
| ## Pull Request Review | ||
|
|
||
| #### How should this be manually tested? | ||
| All pull requests must undergo a thorough review process before being merged. | ||
| The review process of the code PR should include code review, testing, and any necessary feedback or revisions. | ||
| Pull request reviews of functionality developed in other teams only review the given documentation and test reports. | ||
|
|
||
| Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR. | ||
|
|
||
| #### Any background context you want to provide? | ||
| For Node projects: It’s important to make sure changes in `package.json` are also affecting `package-lock.json` correctly. | ||
|
|
||
| ****************************If a dependency is not necessary, don’t add it.**************************** | ||
|
|
||
| #### What are the relevant tickets? | ||
| When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible. | ||
| Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed. | ||
|
|
||
| ## Pull Request Approval | ||
|
|
||
| #### Screenshots | ||
| Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into | ||
| the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR | ||
| by our content writers. | ||
|
|
||
|
|
||
| #### Additional questions | ||
| ## What does this PR do? | ||
|
|
||
|
|
||
| ## Where should the reviewer start? | ||
|
|
||
|
|
||
| ## How should this be manually tested? | ||
|
|
||
|
|
||
| ## Any background context you want to provide? | ||
|
|
||
|
|
||
| ## What are the relevant tickets? | ||
|
|
||
|
|
||
| ## Screenshots | ||
|
|
||
|
|
||
| ## Additional questions |