Even if you don't write code, there are many ways you can help improve the project.
Here are some important resources:
- Safe docs tells you about Safe
- Safe{Core} Protocol Specification tells you about the protocol specifications.
If you are submitting a feature request, please:
- Explain in detail the purpose and how it should work.
- Examples of how it should be implemented along with alternatives are welcome.
If you are submitting a bug report, please:
- Refer to Bug bounty program before creating submitting issue.
- Include the steps to reproduce the bug.
- Include the expected behavior.
- Possible solutions to fix the bug are welcome.
Please send a GitHub Pull Request to safe-core-protocol repository with a clear description of the proposed changes. Each pull request should be associated with an issue and should be made against the main branch.
Branch naming convention:
- For a new feature, use
feature-<issue-number>-short-description - For a bug fix, use
fix-<issue-number>-short-description
Always write a clear log message for your commits. The commit message should look like this:
$ git commit -m "[#<issue-number>] A brief summary of the commit"
Steps to be taken before submitting a pull request to be considered for review:
- Documentation reflects the changes
- Make sure test coverage is close to 100%
- Make sure all tests are passing
- Make sure there are no linting errors
Thanks, Safe team