mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 19:17:58 +00:00
Gav Wood
1e01162505
* Remove unneeded script * Rename Substrate Demo -> Substrate * Rename demo -> node * Build wasm from last rename. * Merge ed25519 into substrate-primitives * Minor tweak * Rename substrate -> core * Move substrate-runtime-support to core/runtime/support * Rename/move substrate-runtime-version * Move codec up a level * Rename substrate-codec -> parity-codec * Move environmental up a level * Move pwasm-* up to top, ready for removal * Remove requirement of s-r-support from s-r-primitives * Move core/runtime/primitives into core/runtime-primitives * Remove s-r-support dep from s-r-version * Remove dep of s-r-support from bft * Remove dep of s-r-support from node/consensus * Sever all other core deps from s-r-support * Forgot the no_std directive * Rename non-SRML modules to sr-* to avoid match clashes * Move runtime/* to srml/* * Rename substrate-runtime-* -> srml-* * Move srml to top-level
51 lines
2.8 KiB
Plaintext
51 lines
2.8 KiB
Plaintext
= Contributing
|
|
|
|
`Substrate` projects is a **OPENISH Open Source Project**
|
|
|
|
== What?
|
|
|
|
Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. A project is more like an open wiki than a standard guarded open source project.
|
|
|
|
== Rules
|
|
|
|
There are a few basic ground-rules for contributors (including the maintainer(s) of the project):
|
|
|
|
. **No `--force` pushes** or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo.
|
|
. **Non-master branches**, prefixed with a short name moniker (e.g. `gav-my-feature`) must be used for ongoing work.
|
|
. **All modifications** must be made in a **pull-request** to solicit feedback from other contributors.
|
|
. A pull-request *must not be merged until CI* has finished successfully.
|
|
. Contributors should adhere to the https://github.com/paritytech/polkadot/wiki/Style-Guide[house coding style].
|
|
|
|
Merging pull requests once CI is successful:
|
|
|
|
. A pull request that does not alter any logic (e.g. comments, dependencies, docs) may be tagged https://github.com/paritytech/core/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+label%3AA2-insubstantial[`insubstantial`] and merged by its author.
|
|
. A pull request with no large change to logic that is an urgent fix may be merged after a non-author contributor has reviewed it well.
|
|
. All other PRs should sit for 48 hours with the https://github.com/paritytech/core/pulls?q=is%3Apr+is%3Aopen+label%3AA0-pleasereview[`pleasereview`] tag in order to garner feedback.
|
|
. No PR should be merged until all reviews' comments are addressed.
|
|
|
|
.Reviewing pull requests:
|
|
When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in:
|
|
|
|
. Buggy behaviour.
|
|
. Undue maintenance burden.
|
|
. Breaking with house coding style.
|
|
. Pessimisation (i.e. reduction of speed as measured in the projects benchmarks).
|
|
. Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on).
|
|
. Uselessness (i.e. it does not strictly add a feature or fix a known issue).
|
|
|
|
.Reviews may not be used as an effective veto for a PR because:
|
|
. There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix.
|
|
. It does not fit well with some other contributors' longer-term vision for the project.
|
|
|
|
== Releases
|
|
|
|
Declaring formal releases remains the prerogative of the project maintainer(s).
|
|
|
|
== Changes to this arrangement
|
|
|
|
This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.
|
|
|
|
== Heritage
|
|
|
|
These contributing guidelines are modified from the "OPEN Open Source Project" guidelines for the Level project: https://github.com/Level/community/blob/master/CONTRIBUTING.md
|