diff --git a/docs/readme.md b/docs/readme.md index abf42901..f2cb1fed 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -6,6 +6,7 @@ Hello! This is where we document various processes for maintaining Jekyll. Being 2. [Reviewing a pull request](reviewing-a-pull-request.md) 3. [Merging a pull request](merging-a-pull-request.md) 4. [Avoiding burnout](avoiding-burnout.md) +5. [Special Labels](special-labels.md) Interested in becoming a maintainer? Here is some documentation for **contributors**: diff --git a/docs/special-labels.md b/docs/special-labels.md new file mode 100644 index 00000000..8ce52597 --- /dev/null +++ b/docs/special-labels.md @@ -0,0 +1,17 @@ +# Maintainers: Special Labels + +**This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone. + +We use a series of "special labels" on GitHub.com to automate handling of some parts of the pull request and issue process. @jekyllbot may automatically apply or remove certain labels based on actions taken by users or maintainers. Below are the labels and how they work: + +## `pending-feedback` + +This label is used to indicate that we need more information from the issue/PR author in order to continue. It may be that you need more info before you can properly triage a bug report, or that you have some unanswered questions about a PR that need to be resolved before moving forward. You can safely ignore any issue with this label, as it is waiting for feedback. + +## `needs-work` & `pending-rebase` + +These labels are used to indicate that the Git state of a pull request must change. Both are removed once a push is registered (a "synchronize" event for the pull request) and the pull request becomes mergable. Add `needs-work` to a PR if, after your review, it requires code changes. Add `pending-rebase` to a PR if the code is fine but the branch is not automatically mergable with the target branch (e.g. `master`). + +## `stale` + +This label is automatically added and removed by @jekyllbot based on activity on an issue or pull request. The rules for this label are laid out in [Triaging an Issue: Staleness and automatic closure](triaging-an-issue.md#staleness-and-automatic-closure).