🗒️PR Template
When submitting a pull request (PR) for Decentra projects, it is essential to follow the standardized PR template to ensure consistency and clarity. Below is the PR template to use for all submissions.
PRs are opened in a local private fork of the desired project, Decentra Teams are added as reviewers and invited to the repo.
The branch name from which the changes are based on should be called "dev", merging into "main".
GitHub PR Template
Pull Request Title
Provide a brief description of the changes made in this PR.
Description
Clearly and concisely describe the changes made in this pull request. Include any relevant context or background information.
Types of Changes
What types of changes does your code introduce? Put an x in all the boxes that apply:
Checklist
Put an x in all the boxes that apply. You can also fill these out after creating the PR. This is a reminder of what we will be looking for before merging your code.
Testing
Explain how you tested your changes.
Provide results of tests and analyses:
Coverage: Include test coverage results.
Security Analysis: Summarize findings from tools like Slither.
Gas Efficiency: Provide gas usage measurements and highlight any optimizations made.
Screenshots (if applicable)
If your changes include UI updates, please add screenshots to help reviewers understand the changes.
Justification
Explain your coding choices and security considerations:
Why did you choose this particular implementation?
What alternatives did you consider, and why were they not chosen?
How does your code ensure security and prevent common vulnerabilities?
Additional Comments
Include any additional comments, questions, or concerns that reviewers should be aware of when reviewing this PR.