Skip to content

Commit

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

[skip ci]

* Clarify 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 Sep 29, 2023
1 parent 7e6b396 commit f56aef8
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## Description

> Provide a brief description about **why** this PR is necessary. Be sure to provide context.
## Related issues and/or PRs

> If this PR addresses or references any issues and/or other PRs, list them here.
## Changes made

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

> 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.
- [ ] 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)

> Provide any additional information or notes that may be relevant to the reviewers or stakeholders.
## Release notes

> 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 f56aef8

Please sign in to comment.