Update CONTRIBUTING.md based on SIP-13 and add how to use labels #6701
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #6701 +/- ##
=======================================
Coverage 56.19% 56.19%
=======================================
Files 520 520
Lines 23181 23181
Branches 2765 2765
=======================================
Hits 13027 13027
Misses 9744 9744
Partials 410 410Continue to review full report at Codecov.
|
kristw
changed the title
kristw
changed the title
kristw
changed the title
john-bodley
approved these changes
Jan 16, 2019
|
Can you add the asf header to this file (html comment works) |
|
@bolkedebruin Can do, but wonder if the ASF header is also required for documentation (markdown) file? |
|
Yes. All non Auto generated files part of the artefacts that make up a release need to have those headers. |
kristw
force-pushed
the
kristw--contrib
branch
from
b85380b
to
d964853
Compare
mistercrunch
approved these changes
Jan 19, 2019
mistercrunch
added
🏷️ bot
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Copy-paste text from SIP-13 with some edits and add this section on how to use labels.
Managing Issues and PRs
To handle issues and PRs that are coming in, committers read issues/PRs and flag them with labels to categorize and help contributors spot where to take actions, as contributors usually have different expertises.
Triaging goals
First, add Category labels (a.k.a. hash labels). Every issue/PR must have one hash label (except spam entry). Labels that begin with
#defines issue/PR type:#bug#code-quality#feature#refine#doc#question#buglater.#SIP#ASFThen add other types of labels as appropriate.
.describe the details of the issue/PR, such as.ui,.js,.install,.backend, etc. Each issue/PR can have zero or more dot labels.need:xxx, which describe the work required to progress, such asneed:rebase,need:update,need:screenshot.risk:xxx, which describe the potential risk on adopting the work, such asrisk:db-migration. The intention was to better understand the impact and create awareness for PRs that need more rigorous testing.abandoned,wontfix,cant-reproduce, etc.) Issue/PRs that are rejected or closed without completion should have one or more status labels.vx.xsuch asv0.28. Version labels on issues describe the version the bug was reported on. Version labels on PR describe the version that the PR will be released with.May also update title to reflect the issue/PR content if the author-provided title is not descriptive enough.
If the PR passes CI tests and does not have any
need:labels, it is ready for review, add labelreviewand/ordesign-review.If an issue/PR has been inactive for >=30 days, it will be closed. If it does not have any status label, add
inactive.@john-bodley @williaster @mistercrunch @graceguo-supercat @michellethomas @betodealmeida @vylc