Skip to content

Commit 7c69d14

Browse files
the-right-joycealvicsamggwpez
authored
update contribution guidelines, remove redundant files (#1181)
* update contribution guidelines, remove redundant files * removing doc ref labels, updating links on contribution * add manifest formatting * update title Co-authored-by: Oliver Tale-Yazdi <[email protected]> * update links to the new repo * terminal friendly convention * update doc guideline format --------- Co-authored-by: Alexander Samusev <[email protected]> Co-authored-by: Oliver Tale-Yazdi <[email protected]>
1 parent fa3b842 commit 7c69d14

File tree

11 files changed

+581
-352
lines changed

11 files changed

+581
-352
lines changed

cumulus/docs/documentation.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers
6+
pledge to making participation in our project and our community a harassment-free experience for
7+
everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level
8+
of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
9+
10+
## Our Standards
11+
12+
Examples of behavior that contributes to creating a positive environment include:
13+
14+
* Using welcoming and inclusive language
15+
* Being respectful of differing viewpoints and experiences
16+
* Gracefully accepting constructive criticism
17+
* Focusing on what is best for the community
18+
* Showing empathy towards other community members
19+
20+
Examples of unacceptable behavior by participants include:
21+
22+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
23+
* Trolling, insulting/derogatory comments, and personal or political attacks
24+
* Public or private harassment
25+
* Publishing others' private information, such as a physical or electronic address, without explicit
26+
permission
27+
* Other conduct which could reasonably be considered inappropriate in a professional setting
28+
29+
### Facilitation, Not Strongarming
30+
31+
We recognize that this software is merely a tool for users to create and maintain their blockchain
32+
of preference. We see that blockchains are naturally community platforms with users being the
33+
ultimate decision makers. We assert that good software will maximize user agency by facilitating
34+
user-expression on the network. As such:
35+
36+
* This project will strive to give users as much choice as is both reasonable and possible over what
37+
protocol they adhere to; but
38+
* Use of the project's technical forums, commenting systems, pull requests and issue trackers as a
39+
means to express individual protocol preferences is forbidden.
40+
41+
## Our Responsibilities
42+
43+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are
44+
expected to take appropriate and fair corrective action in response to any instances of unacceptable
45+
behavior.
46+
47+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits,
48+
code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to
49+
ban temporarily or permanently any contributor for other behaviors that they deem inappropriate,
50+
threatening, offensive, or harmful.
51+
52+
## Scope
53+
54+
This Code of Conduct applies both within project spaces and in public spaces when an individual is
55+
representing the project or its community. Examples of representing a project or community include
56+
using an official project e-mail address, posting via an official social media account, or acting as
57+
an appointed representative at an online or offline event. Representation of a project may be further
58+
defined and clarified by project maintainers.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting
63+
the project team at <[email protected]>. The project team will review and investigate all complaints,
64+
and will respond in a way that it deems appropriate to the circumstances. The project team is
65+
obligated to maintain confidentiality with regard to the reporter of an incident. Further details of
66+
specific enforcement policies may be posted separately.
67+
68+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary
69+
or permanent repercussions as determined by other members of the project's leadership.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
74+
https://contributor-covenant.org/version/1/4
75+
76+
[homepage]: https://contributor-covenant.org

docs/CONTRIBUTING.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributing
2+
3+
The `Polkadot SDK` project is an **OPENISH Open Source Project**
4+
5+
## What?
6+
7+
Individuals making significant and valuable contributions are given commit-access to the project.
8+
Contributions are done via pull-requests and need to be approved by the maintainers.
9+
10+
## Rules
11+
12+
There are a few basic ground-rules for contributors (including the maintainer(s) of the project):
13+
14+
1. **No `--force` pushes** or modifying the master branch history in any way.
15+
If you need to rebase, ensure you do it in your own repo. No rewriting of the history
16+
after the code has been shared (e.g. through a Pull-Request).
17+
2. **Non-master branches**, prefixed with a short name moniker (e.g. `gav-my-feature`) must be
18+
used for ongoing work.
19+
3. **All modifications** must be made in a **pull-request** to solicit feedback from other contributors.
20+
4. A pull-request **must not be merged until CI** has finished successfully.
21+
5. Contributors should adhere to the [house coding style](./STYLE_GUIDE.md).
22+
6. Contributors should adhere to the [house documenting style](./DOCUMENTATION_GUIDELINES.md), when applicable.
23+
24+
## Merge Process
25+
26+
### In General
27+
28+
A Pull Request (PR) needs to be reviewed and approved by project maintainers.
29+
If a change does not alter any logic (e.g. comments, dependencies, docs), then it may be tagged
30+
`A1-insubstantial` and merged faster.
31+
If it is an urgent fix with no large change to logic, then it may be merged after a non-author
32+
contributor has reviewed it well and approved the review once CI is complete.
33+
No PR should be merged until all reviews' comments are addressed.
34+
35+
### Labels:
36+
37+
The set of labels and their description can be found [here](linktobeinserted)
38+
39+
### Process:
40+
41+
1. Please use our [Pull Request Template](./PULL_REQUEST_TEMPLATE.md) and make sure all relevant
42+
information is reflected in your PR.
43+
2. Please tag each PR with minimum one `T*` label. The respective `T*` labels should signal the
44+
component that was changed, they are also used by downstream users to track changes and to
45+
include these changes properly into their own releases.
46+
3. If your’re still working on your PR, please submit as “Draft”. Once a PR is ready for review change
47+
the status to “Open”, so that the maintainers get to review your PR. Generally PRs should sit for
48+
48 hours in order to garner feedback. It may be merged before if all relevant parties had a look at it.
49+
4. If you’re introducing a major change, that might impact the documentation please add the label
50+
`T13-documentation`. The docs team will get in touch.
51+
5. If your PR changes files in these paths:
52+
53+
`polkadot` : '^runtime/polkadot'
54+
`polkadot` : '^runtime/kusama'
55+
`polkadot` : '^primitives/src/'
56+
`polkadot` : '^runtime/common'
57+
`substrate` : '^frame/'
58+
`substrate` : '^primitives/'
59+
60+
It should be added to the [security audit board](https://github.com/orgs/paritytech/projects/103)
61+
and will need to undergo an audit before merge.
62+
6. PRs will be able to be merged once all reviewers' comments are addressed and CI is successful.
63+
64+
**Noting breaking changes:**
65+
When breaking APIs, the PR description should mention what was changed alongside some examples on how
66+
to change the code to make it work/compile.
67+
It should also mention potential storage migrations and if they require some special setup aside adding
68+
it to the list of migrations in the runtime.
69+
70+
## Reviewing pull requests:
71+
72+
When reviewing a pull request, the end-goal is to suggest useful changes to the author.
73+
Reviews should finish with approval unless there are issues that would result in:
74+
1. Buggy behavior.
75+
2. Undue maintenance burden.
76+
3. Breaking with house coding style.
77+
4. Pessimization (i.e. reduction of speed as measured in the projects benchmarks).
78+
5. Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on).
79+
6. Uselessness (i.e. it does not strictly add a feature or fix a known issue).
80+
81+
The reviewers are also responsible to check:
82+
83+
a) if a changelog is necessary and attached
84+
85+
b) the quality of information in the changelog file
86+
87+
c) the PR has an impact on docs
88+
89+
d) that the docs team was included in the review process of a docs update
90+
91+
**Reviews may not be used as an effective veto for a PR because**:
92+
1. There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix.
93+
2. It does not fit well with some other contributors' longer-term vision for the project.
94+
95+
## Helping out
96+
97+
We use [labels](https://github.com/paritytech/polkadot-sdk/labels) to manage PRs and issues and communicate
98+
state of a PR. Please familiarise yourself with them. Best way to get started is to a pick a ticket tagged
99+
`[easy](https://github.com/paritytech/polkadot-sdk/issues?q=is%3Aopen+is%3Aissue+label%3AD0-easy)`
100+
or `[medium](https://github.com/paritytech/polkadot-sdk/issues?q=is%3Aopen+is%3Aissue+label%3AD1-medium)`
101+
and get going or `[mentor](https://github.com/paritytech/polkadot-sdk/issues?q=is%3Aopen+is%3Aissue+label%3AC1-mentor)`
102+
and get in contact with the mentor offering their support on that larger task.
103+
104+
****
105+
106+
### Issues
107+
108+
If what you are looking for is an answer rather than proposing a new feature or fix, search
109+
[https://substrate.stackexchange.com](https://substrate.stackexchange.com/) to see if an post already
110+
exists, and ask if not. Please do not file support issues here.
111+
Before opening a new issue search to see if a similar one already exists and leave a comment that you
112+
also experienced this issue or add your specifics that are related to an existing issue.
113+
Please label issues with the following labels:
114+
1. `I*` issue severity and type. EXACTLY ONE REQUIRED.
115+
2. `D*` issue difficulty, suggesting the level of complexity this issue has. AT MOST ONE ALLOWED.
116+
3. `T*` Issue topic. MULTIPLE ALLOWED.
117+
118+
## Releases
119+
120+
Declaring formal releases remains the prerogative of the project maintainer(s).
121+
122+
## UI tests
123+
124+
UI tests are used for macros to ensure that the output of a macro doesn’t change and is in the expected format.
125+
These UI tests are sensible to any changes in the macro generated code or to switching the rust stable version.
126+
The tests are only run when the `RUN_UI_TESTS` environment variable is set. So, when the CI is for example complaining
127+
about failing UI tests and it is expected that they fail these tests need to be executed locally.
128+
To simplify the updating of the UI test ouput there is the `.maintain/update-rust-stable

0 commit comments

Comments
 (0)