From b1c09946cb3a7e1df5068d123f1bf778e6229574 Mon Sep 17 00:00:00 2001 From: Yeastplume Date: Tue, 19 Feb 2019 14:29:58 +0000 Subject: [PATCH] Update contributing guidelines (#2563) * update contributing guidelines * add pull request template --- .github/pull_request_template.md | 18 ++++++++++++++++++ CONTRIBUTING.md | 18 +++++++++++++++++- 2 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..bffb612d1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,18 @@ +--- +name: Pull Request +about: Pull Request checklist +title: '' +labels: '' +assignees: '' + +--- +If your PR is a work in progress, please feel free to create it and include a [WIP] tag in the PR name. We encourage everyone to PR early and often so that other developers know what you're working on. + +Before submitting your PR for final review, please ensure that it: + +* Includes a proper description of what problems the PR addresses, as well as a detailed explanation as to what it changes +* Explains whether/how the change is consensus breaking or breaks existing client functionality +* Contains unit tests exercising new/changed functionality +* Fully considers the potential impact of the change on other parts of the system +* Describes how you've tested the change (e.g. against Floonet, etc) +* Updates any documentation that's affected by the PR diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7615e12d3..9607f69c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,23 @@ The [list of issues](https://github.com/mimblewimble/grin/issues) is a good plac Additional tests are rewarded with an immense amount of positive karma. -More documentation or updates/fixes to existing documentation are also very welcome. However, if submitting a PR(Pull-Request) consisting of documentation changes only, please try to ensure that the change is significantly more substantial than one or two lines. For example, working through an install document and making changes and updates throughout as you find issues is worth a PR. For typos and other small changes, either contact one of the developers, or if you think it's a significant enough error to cause problems for other users, please feel free to open an issue. +More documentation or updates/fixes to existing documentation are also very welcome. + +# PR Guidelines + +We generally prefer you to PR your work earlier rather than later. This ensures everyone else has a better idea of what's being worked on, and can help reduce wasted effort. If work on your PR has just begun, please feel free to create the PR with [WIP] (work in progress) in the PR title, and let us know when it's ready for review in the comments. + +Since mainnet has been released, the bar for having PRs accepted has been raised. Before submitting your PR for approval, please be ensure it: +* Includes a proper description of what problems the PR addresses, as well as a detailed explanation as to what it changes +* Explains whether/how the change is consensus breaking or breaks existing client functionality +* Contains unit tests exercising new/changed functionality +* Fully considers the potential impact of the change on other parts of the system +* Describes how you've tested the change (e.g. against Floonet, etc) +* Updates any documentation that's affected by the PR + +If submitting a PR consisting of documentation changes only, please try to ensure that the change is significantly more substantial than one or two lines. For example, working through an install document and making changes and updates throughout as you find issues is worth a PR. For typos and other small changes, either contact one of the developers, or if you think it's a significant enough error to cause problems for other users, please feel free to open an issue. + +The development team will be happy to help and guide you with any of these points and work with you getting your PR submitted for approval. Create a PR with [WIP] in the title and ask for specific assistance within the issue, or contact the dev team on any of the channels below. # Find Us