Skip to content

Commit

Permalink
Update pull request (PR) template (#37)
Browse files Browse the repository at this point in the history
* Update pull_request_template.md

* Update pull_request_template.md

Making change to skip ci on push

* Update pull_request_template.md

[skip ci]

* Revise descriptions

[skip ci]

Add `Checklist` description, and revise the `Related issues and/or PRs` description since the previous description might conflict with how GitHub handles PR linking.

Ref: scalar-labs/scalardb#1114

* Remove `How these changes were tested` section

[skip ci]
  • Loading branch information
josh-wong authored Oct 2, 2023
1 parent 5dd9185 commit f61d808
Showing 1 changed file with 22 additions and 13 deletions.
35 changes: 22 additions & 13 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,34 @@
## Description

Please provide a brief description of the why this PR is necessary and the changes introduced in this pull request.
> Provide a brief description about **why** this PR is necessary. Be sure to provide context.
## Related Issue(s)
## Related issues and/or PRs

If this PR addresses or references any issues, please list them here. For example, "Fixes #123" or "Addresses #456".
> If this PR addresses or references any issues and/or other PRs, list them here.
## Changes Made
## Changes made

Outline the specific changes made in this pull request. Include relevant details such as added features, bug fixes, code refactoring, or improvements.
> Outline the specific changes made in this pull request. Include relevant details, such as added features, bug fixes, code refactoring, or improvements.
## Testing Done
## Checklist

Describe the testing you have performed to ensure the changes are working as expected. Include details of the test cases or scenarios covered.
> The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.
## Checklist
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have updated the documentation to reflect the changes.
- [ ] Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
- [ ] Tests (unit, integration, etc.) have been added for the changes.
- [ ] My changes generate no new warnings.
- [ ] Any dependent changes in other PRs have been merged and published.

## Additional notes (optional)

- [ ] Unit tests have been added for the changes. (if applicable).
- [ ] The documentation has been updated to reflect the changes (if applicable).
- [ ] Any remaining open issues linked to this PR are documented (JIRA,GitHub).
> Provide any additional information or notes that may be relevant to the reviewers or stakeholders.
## Additional Notes (optional)
## Release notes

Provide any additional information or notes that may be relevant to the reviewers or stakeholders.
> Provide release note text for this PR based on the guidelines at [Guidelines for Writing Release Notes](https://developers.scalar-labs.com/docs/style-guide/release-notes/).
>
> For example:
>
> Added validation for the Consensus Commit mutation operation.

0 comments on commit f61d808

Please sign in to comment.