-
Notifications
You must be signed in to change notification settings - Fork 14.6k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Update CONTRIBUTING.md based on SIP-13 and add how to use labels #6701
Conversation
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 410 Continue to review full report at Codecov.
|
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. |
b85380b
to
d964853
Compare
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
#bug
later.#SIP
#ASF
Then 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.x
such 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 labelreview
and/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