From 75da71dfc3859664807e81e48ebb0508a8f54737 Mon Sep 17 00:00:00 2001 From: Akshay Date: Fri, 6 Oct 2023 11:17:57 +0200 Subject: [PATCH] Add contribution guidelines (#114) * [#107] Add contribution guidelines * [#107] Add link to bug bounty program, update coverage expectation in contribution guidelines * [#107] Create pull_request_template.md * [#107] Create issue_template.md * Update pull_request_template.md --- .github/issue_template.md | 18 +++++++++++++ .github/pull_request_template.md | 12 +++++++++ CONTRIBUTING.md | 43 ++++++++++++++++++++++++++++++++ 3 files changed, 73 insertions(+) create mode 100644 .github/issue_template.md create mode 100644 .github/pull_request_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 00000000..b3007578 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,18 @@ +**Description** + +... + +_Remove below if not relevant_ + +**Steps to reproduce bug** +- Step 1 +- Step 2 +- ... + +**Expected behaviour** + +... + +**Possible solutions with alternatives** + +... diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..a415054f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,12 @@ + +_Use one of the below_ + +Fixes to #issue-number + +Relates to #issue-number + +**Changes in PR:** + +- Change 1 +- Change 2 +- ... diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..adfc1e7a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,43 @@ +# Contributing to Safe Core Protocol + +Even if you don't write code, there are many ways you can help improve the project. + +Here are some important resources: + + * [Safe docs](https://docs.safe.global) tells you about Safe + * [Safe{Core} Protocol Specification](https://github.com/safe-global/safe-core-protocol-specs) tells you about the protocol specifications. + +## Submitting issues + +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](https://docs.safe.global/safe-smart-account/security/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. + +## Submitting changes + +Please send a [GitHub Pull Request to safe-core-protocol repository](https://github.com/safe-global/safe-core-protocol) 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--short-description` +- For a bug fix, use `fix--short-description` + +Always write a clear log message for your commits. The commit message should look like this: + + $ git commit -m "[#] 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 \ No newline at end of file