-
Notifications
You must be signed in to change notification settings - Fork 1.6k
add PR guideline, update CONTRIBUTING.md, move spellcheck #5390
Changes from 4 commits
4ab0202
f7303bb
ff4ea87
e94efb6
bdf3752
cea43ed
0d5b720
d4263fe
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Description | ||
|
|
||
| <!-- | ||
| A crisp summary | ||
| Fixes # | ||
| Ref # | ||
| --> | ||
|
|
||
| <!-- | ||
| Apply labels! | ||
| --> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This looks a bit too much imperative... also I feel it might be not clear to a new contributor what exactly he should do here. The item in the checklist helps, but why do we need this comment here then? |
||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] Labels applied correctly? See the [contributing guidlines](../CONTRIBUTING.md). | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. External contributors cannot apply labels. |
||
| - [ ] Workspace compiles `cargo build --workspace`? | ||
drahnr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - [ ] Workspace tests `cargo test --workspace`? | ||
|
||
| - [ ] Applied `cargo +nightly fmt` with the version from CI? | ||
| - [ ] Ran `cargo spellcheck` without any fallout? If any, update `.spellcheck/lingua.dic`. | ||
|
||
| - [ ] Fixed any fallout caused by these changes in `cumulus`? | ||
ordian marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - [ ] Referenced relevant companion pullrequests of `substrate` and `cumulus`? | ||
| - [ ] Does the change mandate an _architecture design record_ being committed? | ||
drahnr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <!-- | ||
| ## Companions: | ||
| Must be last! | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why though? And is the contributor supposed remove the comment? Otherwise, it won't be last due to the |
||
| substrate companion: https://github.com/paritytech/substrate/pulls/ | ||
| cumulus companion: https://github.com/paritytech/cumulus/pulls/ | ||
| --> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -273,7 +273,7 @@ spellcheck: | |
| - git fetch origin +${CI_DEFAULT_BRANCH}:${CI_DEFAULT_BRANCH} | ||
| - echo "___Spellcheck is going to check your diff___" | ||
| - cargo spellcheck list-files -vvv $(git diff --diff-filter=AM --name-only $(git merge-base ${CI_COMMIT_SHA} ${CI_DEFAULT_BRANCH} -- :^bridges)) | ||
| - time cargo spellcheck check -vvv --cfg=scripts/gitlab/spellcheck.toml --checkers hunspell --code 1 | ||
| - time cargo spellcheck check -vvv --cfg=.spellcheck/spellcheck.toml --checkers hunspell --code 1 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it necessary to move this file to the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, I was opposing the change to move them out of there from the get go, since that's the default discovery location of There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. arg is not that bad, but what if someone wants several config files for the different crates, dirs, and languages? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. btw you still use the extra arg here There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, I use the extra arg here for explicitness. But for the average user I'd not want that. If the file does not reside in the default lookup dir, the contributor sees an excessive amount of detected errors, that are covered by |
||
| $(git diff --diff-filter=AM --name-only $(git merge-base ${CI_COMMIT_SHA} ${CI_DEFAULT_BRANCH} -- :^bridges)) | ||
| allow_failure: true | ||
|
|
||
|
|
@@ -854,5 +854,3 @@ cancel-pipeline: | |
| PROJECT_ID: "${CI_PROJECT_ID}" | ||
| PIPELINE_ID: "${CI_PIPELINE_ID}" | ||
| trigger: "parity/infrastructure/ci_cd/pipeline-stopper" | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -8,7 +8,10 @@ There are a few basic ground-rules for contributors (including the maintainer(s) | |||||||||
| - **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 [house coding style](https://github.com/paritytech/polkadot/wiki/Style-Guide). | ||||||||||
| - Contributors should apply `cargo +nightly fmt` with the version used in CI. | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. but still, no need in this step as it's done by CI anyway There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was under the impression we could use the |
||||||||||
| - Synchronized changes must have annotations with the respective [companion PRs of substrate and cumulus](https://github.com/paritytech/substrate/blob/master/docs/CONTRIBUTING.adoc#updating-polkadot-as-well), tl;dr add the following lines at the _end_ of your PR description: | ||||||||||
drahnr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||
| - `substrate companion: https://github.com/paritytech/substrate/pulls/#1234` | ||||||||||
| - `cumulus companion: https://github.com/paritytech/cumulus/pulls/#5678` | ||||||||||
|
|
||||||||||
| ### Merging pull requests once CI is successful | ||||||||||
|
|
||||||||||
|
|
@@ -33,6 +36,21 @@ When reviewing a pull request, the end-goal is to suggest useful changes to the | |||||||||
| - 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. | ||||||||||
|
|
||||||||||
| ### Helping out | ||||||||||
|
|
||||||||||
| We use labels to manage PRs and issues and communicate 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 or medium and get going or mentor and get in contact with the mentor offering their support on that larger task. | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We could also provide quick links to those task queries to reduce friction a bit for a potential contributor. |
||||||||||
| Issues | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| Please label issues with the following labels: | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
I am suggesting this to not confuse the readers. Right now it reads as if we are asking the new contributors to help label issues. Ideally, we don't accept this change but just move this guidance elsewhere. |
||||||||||
|
|
||||||||||
| I-* Issue severity and type. EXACTLY ONE REQUIRED. | ||||||||||
|
|
||||||||||
| P-* Issue priority. AT MOST ONE ALLOWED. | ||||||||||
|
|
||||||||||
| Q-* Issue difficulty. AT MOST ONE ALLOWED. | ||||||||||
|
|
||||||||||
| Z-* More general tags on the issue, denoting context and resolution. | ||||||||||
|
|
||||||||||
| ## Releases | ||||||||||
|
|
||||||||||
| Declaring formal releases remains the prerogative of the project maintainer(s). | ||||||||||
|
|
||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel that an external contributor may not be fully clear on what this is. I feel that this should be full sentences. Maybe something along those lines:
"Hello and thank you for the pull request.
Please leave a crisp summary of the issue that you are solving with the issues linked that describe the issue itself".
I don't think we should strive for brevity here. The reason is, a user to developer will probably skip the static prompt part. I can guarantee that this will be an automatic action for most people. They won't even notice it after a while.
On the other hand, a newcomer may appreciate if you write in the expanded form right away.