vacp2p/status-linea-besu
1
0
Fork 0
mirror of https://github.com/vacp2p/status-linea-besu.git synced 2026-01-08 21:38:15 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update Contributing Guidelines (#222)

Browse Source 
* Update Contributing Guidelines

Signed-off-by: Tim Beiko <t.beiko23@gmail.com>

* Update testing section

Signed-off-by: Tim Beiko <t.beiko23@gmail.com>

* Use headers instead of <details>

Signed-off-by: Tim Beiko <t.beiko23@gmail.com>
This commit is contained in:
Tim Beiko
2019-11-27 18:08:07 -05:00
committed by GitHub
parent ac21115f0b
commit 1ad364c9d9
1 changed files with 26 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
CONTRIBUTING.md
View File

@@ -206,15 +206,35 @@ Please follow these steps to have your contribution considered by the approvers:
1. Ensure all commits have a Sign-off for DCO, as described in [DCO.md].
2. Follow all instructions in [PULL-REQUEST-TEMPLATE.md](.github/pull_request_template.md).
3. Include appropriate test coverage. Testing is 100% automated. There is no such thing as a manual test.
3. Include appropriate test coverage. Testing is 100% automated. All submissions must be testable in an automated fashion.
4. Follow the [Style Guides](#style-guides).
5. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/)
are passing.
<details><summary>What if the status checks are failing?</summary>If a status check is failing,
and you believe that the failure is unrelated to your change, please leave a comment on the pull request
explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you.
If we conclude that the failure was a false positive, then we will open an issue to track that problem
with our status check suite.</details>
#### What Makes A Good Pull Request?
The following guidelines, based on Hyperledger Fabic's [contribution guidelines](https://hyperledger-fabric.readthedocs.io/en/latest/CONTRIBUTING.html#what-makes-a-good-pull-request) will help ensure that your pull request gets promptly reviewed.
##### One Pull Request, One Change
* This limits the surface area of the change, and makes it easier to identify root causes when issues arise.
##### Link to JIRA
* When submitting your PR, include the JIRA ticket's link in the description and number in the title (i.e. `[BESU-99] My Awesome PR`), this helps provide more context on your work and auto-update the JIRA ticket to include a link to your PR.
##### Minimize LOCs per PR
* PRs get near exponentially longer to review as the number of lines of code increase. Ideally, try and keep your changes to under 300 LOC. If that is not possible, try and break up your PR into smaller ones for reviewers to review sequentially.
* One way to do this if, for some reason, the change has to all go in the codebase at once, is to have a PR open on the Besu repository linking to smaller PRs on your Besu fork.
##### Write Meaningful Commit Messages
* As mentioned above, your commit title should include the JIRA ticket number (i.e. `[BESU-99]`) while the description should link to the jira ticket. Please include a comprehensive description of the changes in your commit description.
##### Be Responsive
* Don't let a PR sit idle with unaddressed comments until it gets to a point where you need to rebase the whole thing. If you are pausing your work on an issue, please indicate it in the PR comments.
##### What if the status checks are failing?
* If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you.
* If we conclude that the failure was a false positive, then we will open an issue to track that problem
with our status check suite.
## Code Review
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s)