grassrootseconomics/openethereum
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
ea9322f9c1
openethereum/.github/CONTRIBUTING.md
Luke Schoen 6022c47b53 docs: Update Readme with TOC, Contributor Guideline. Update Cargo package descriptions (#10652) 
* docs: Update Readme with TOC, Contributor Guide and License sections

* docs: Simplify package descriptions in Readme

* docs: Fix typos

* docs: Update Cargo package configs adding missing descriptions

* fix: Remove machine since was accidental from diff branch. Fix contribting indentation.

* fix: Fix formatting

* remove details snippet since not code and formats badly

* review-fix: Remove duplicate description

* fix dot point formatting

* fix: Add missing description to vm package

* fix: Remove duplicate Code of Conduct and Contributor guidelines

* docs: Update Contributing for consistency with other repos

* docs: Update Readme to link to existing Code of Conduct and Contributor guidelines in .github folder

* refactor: Add missing space

* fix: Fix links to be markdown format

* review-fix: Update CONTRIBUTING.md to link to Parity Ethereum Style Guide

* docs: Fix type in .github/CONTRIBUTING.md

Co-Authored-By: David <dvdplm@gmail.com>

* docs: Fix typo in .github/CONTRIBUTING.md

Co-Authored-By: David <dvdplm@gmail.com>

* docs: Rephrase parity-clib/Cargo.toml

Co-Authored-By: David <dvdplm@gmail.com>

* review-fix: Fix whole paragraph

* review-fix: Add comment to prevent direct pushes to master branch

* review-fix: Change some rules to recommendations

* Update .github/CONTRIBUTING.md

Co-Authored-By: Tomasz Drwięga <tomusdrw@users.noreply.github.com>

* review-fix: Replace feature reduction with breaking changes dot point

* review-fix: Rephrase what to do when reviewing PR

* review-fix: Update parity-rpc package description and module rustdocs

* docs: Add missing fullstop

* review-fix: Update rustdoc section to show all packages first as default

* review-fix: Rename Parity Util to Parity Core Libraries

* review-fix: Rename readme too for the C bindings name change

* review-fix: Remove some docs since we do not teach the reader Rust

* review-fix: Wrap Parity Ethereum specific packages in a details section

* review-fix: Separate tools that are in this repo vs those that are not

* review-fix: Add link to ethabi on crates.io

* review-fix: Remove unnecessary extra line talking about pushing to master

* review-fix: Remove useless summary of parts of the rust book documentation section

* docs: Update .github/CONTRIBUTING.md to specify two reviewers required

Co-Authored-By: David <dvdplm@gmail.com>

* docs: Update README.md with simplification

Co-Authored-By: David <dvdplm@gmail.com>

* docs: Update README.md renaming to Test Runner instead of just Run

Co-Authored-By: David <dvdplm@gmail.com>

* review-fix: Remove hardware wallet from docs

* review-fix: Remove veto PR section of contributor doc

* review-fix: Change to test generator title
2019-06-25 08:15:13 +02:00

4.6 KiB
Raw Blame History

Contributing Guidelines

Do you have a question?

Check out our Basic Usage, Configuration, and FAQ articles on our wiki!

See also frequently asked questions tagged with parity on Stack Exchange.

Report bugs!

Do not open an issue on Github if you think your discovered bug could be a security-relevant vulnerability. Please, read our security policy instead.

Otherwise, just create a new issue in our repository and state:

  • What's your Parity Ethereum version?
  • What's your operating system and version?
  • How did you install Parity Ethereum?
  • Is your node fully synchronized?
  • Did you try turning it off and on again?

Also, try to include steps to reproduce the issue and expand on the actual versus expected behavior.

Contribute!

If you would like to contribute to Parity Ethereum, please fork it, fix bugs or implement features, and propose a pull request.

Labels & Milestones

We use labels to manage PRs and issues and communicate the state of a PR. Please familiarize yourself with them. Furthermore we are organizing issues in milestones. Best way to get started is to a pick a ticket from the current milestone tagged easy and get going, or mentor and get in contact with the mentor offering their support on that larger task.

Rules

There are a few basic ground-rules for contributors (including the maintainer(s) of the project):

  • No pushing directly to the master branch.
  • All modifications must be made in a pull-request to solicit feedback from other contributors.
  • Pull-requests cannot be merged before CI runs green and two reviewers have given their approval.
  • Contributors should adhere to the Parity Ethereum Style Guide.

Recommendations

  • Non-master branch names should be prefixed with a short name moniker, followed by the associated Github Issue ID (if any), and a brief description of the task using the format <GITHUB_USERNAME>-<ISSUE_ID>-<BRIEF_DESCRIPTION> (e.g. gavin-123-readme). The name moniker helps people to inquiry about their unfinished work, and the GitHub Issue ID helps your future self and other developers (particularly those who are onboarding) find out about and understand the original scope of the task, and where it fits into Parity Ethereum Projects.
  • Remove stale branches periodically

Preparing Pull Requests

  • If your PR does not alter any logic (e.g. comments, dependencies, docs), then it may be tagged insubstantial.

  • Once a PR is ready for review please add the pleasereview label.

Reviewing Pull Requests*:

  • At least two reviewers are required to review PRs (even for PRs tagged insubstantial).

When doing a review, make sure to look for any:

  • Buggy behavior.
  • Undue maintenance burden.
  • Breaking with house coding style.
  • Pessimization (i.e. reduction of speed as measured in the projects benchmarks).
  • Breaking changes should be carefuly reviewed and tagged as such so they end up in the changelog.
  • Uselessness (i.e. it does not strictly add a feature or fix a known issue).

License.

By contributing to Parity Ethereum, you agree that your contributions will be licensed under the GPLv3 License.

Each contributor has to sign our Contributor License Agreement. The purpose of the CLA is to ensure that the guardian of a project's outputs has the necessary ownership or grants of rights over all contributions to allow them to distribute under the chosen license. You can read and sign our full Contributor License Agreement at cla.parity.io before submitting a pull request.