NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add guidelines for pull requests (#4002)

Browse Source
This commit is contained in:
Francisco
2023-01-26 14:17:18 -03:00
committed by GitHub
parent 69c8d1010e
commit d6fb3d645f
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
GUIDELINES.md
View File

@ -62,6 +62,20 @@ Some other examples of automation are:
- Looking for common security vulnerabilities or errors in our code (eg. reentrancy analysis). - Looking for common security vulnerabilities or errors in our code (eg. reentrancy analysis).
- Keeping dependencies up to date and monitoring for vulnerable dependencies. - Keeping dependencies up to date and monitoring for vulnerable dependencies.
## Pull requests
Pull requests are squash-merged to keep the `master` branch history clean. The title of the pull request becomes the commit message, so it should be written in a consistent format:
1) Begin with a capital letter.
2) Do not end with a period.
3) Write in the imperative: "Add feature X" and not "Adds feature X" or "Added feature X".
This repository does not follow conventional commits, so do not prefix the title with "fix:" or "feat:".
Work in progress pull requests should be submitted as Drafts and should not be prefixed with "WIP:".
Branch names don't matter, and commit messages within a pull request mostly don't matter either, although they can help the review process.
# Solidity Conventions # Solidity Conventions
In addition to the official Solidity Style Guide we have a number of other conventions that must be followed. In addition to the official Solidity Style Guide we have a number of other conventions that must be followed.