Skip to content

Commit

Permalink
Auto merge of #1716 - rubygems:update-contributing, r=segiddins
Browse files Browse the repository at this point in the history 
Update Contributing.rdoc with new label usage

---

I will abide by the [code of conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md).

---

reference issue: #1715

Some labels were changed in https://github.com/rubygems/rubygems/labels to match this document

- Add the `closed: discussion` label
- Workflow labels are denoted by `status: *`
- All labels in the same broad category now share a color
- Adding a space to "bug fix" allows it to be sorted next to "bug report"
- Add type: documentation
- Minor syntax and wording changes
- A list of other changes are mentioned in the commit descriptions
  • Loading branch information
@homu
homu committed Sep 21, 2016
2 parents 7298924 + 1fb0d3e commit 7fc150a
Showing 1 changed file with 51 additions and 52 deletions.
103 changes: 51 additions & 52 deletions CONTRIBUTING.rdoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ contributors to follow to reduce the time it takes to get changes merged in.
2. Ensure that your code blends well with ours:
* No trailing whitespace
* Match indentation (two spaces)
* Match coding style (`if`, `elsif`, `when` need trailing `then`)
* Match coding style (+if+, +elsif+, +when+ need trailing +then+)

3. If any new files are added or existing files removed in a commit or PR, please update the `Manifest.txt` accordingly.
3. If any new files are added or existing files removed in a commit or PR, please update the +Manifest.txt+ accordingly.

4. Don't modify the history file or version number.

Expand All @@ -28,7 +28,7 @@ here: http://guides.rubygems.org/contributing/
$ gem install hoe
$ rake newb

To run commands like `gem install` from the repo:
To run commands like <tt>gem install</tt> from the repo:

$ ruby -Ilib bin/gem install

Expand All @@ -38,59 +38,65 @@ RubyGems uses labels to track all issues and pull requests. In order to provide
guidance to the community this is documentation of how labels are used in the
rubygems repository.

=== Contribution

These labels are made to guide contributors to issue/pull requests that they
can help with. That are marked with a light gray <tt>contribution: *</tt>

* *small* - The issue described here will take a small amount of work to resolve,
and is a good option for a new contributor
* *unclaimed* - The issue has not been claimed for work, and is awaiting willing
volunteers!

=== Type

Most Issues or pull requests will have one of these labels, which describes the
type of the issue or pull request.
Most Issues or pull requests will have a light green <tt>type: *</tt> label,
which describes the type of the issue or pull request.

* <b>bug report</b> - An issue describing a bug in rubygems. This would be something
that is broken, confusing, unexpected behavior etc.
* <b>bugfix</b> - A pull request that fixes a bug report.
* <b>bug fix</b> - A pull request that fixes a bug report.
* <b>feature request</b> - An issue describing a request for a new feature or
enhancement.
* <b>feature implementation</b> - A pull request implementing a feature request.
* <b>question</b> - An issue that is a more of a question than a call for specific
* *question* - An issue that is a more of a question than a call for specific
changes in the codebase.
* <b>cleanup</b> - Generally for a pull request that improves the code base without
* *cleanup* - Generally for a pull request that improves the code base without
fixing a bug or implementing a feature.
* <b>major bump</b> - This issue or pull request requires a major version bump
* <b>administrative</b> - This issue relates to adminstrative tasks that need to
* *administrative* - This issue relates to adminstrative tasks that need to
take place as it relates to rubygems
* *documentation* - This issue relates to improving the documenation for
in this repo. Note that much of the rubygems documentation is here:
https://github.com/rubygems/guides

Bug report and Bugfix have the same color. And feature implementation and
feature request have the same color since they are related labels.
=== Workflow / Status

=== Workflow
The light yellow <tt>status: *</tt> labels that indicate the state of an
issue, where it is in the process from being submitted to being closed.
These are listed in rough progression order from submitted to closed.

These are labels that indicate the state of an issue, where it is in the process
from being submitted to being closed. These are listed in rough progression
order from submitted to closed.

* <b>triage</b> - This is an issue or pull request that needs to be properly
* *triage* - This is an issue or pull request that needs to be properly
labeled by by a maintainer.
* <b>accepted</b> - This issue / pull request has been accepted as valid and
will be worked on by someone.
* <b>ready for work</b> - An issue that is available for collaboration. This issue
* *confirmed* - This issue/pull request has been accepted as valid, but
is not yet immediately ready for work.
* <b>ready</b> - An issue that is available for collaboration. This issue
should have existing discussion on the problem, and a description of how to go
about solving it. This label should be removed once someone has said they are
going to work on it.
* <b>claimed</b> - An issue that is claimed by a member of the community and is
working on it. If the member can be assigned to the issue, they should be.
* <b>feedback</b>- This issue/pull request is waiting on feedback from
one ore more of the folks involved in the issue. Generally their should be an
<tt>@username/team</tt> in the issue indicating who should respond.
* <b>blocked</b> - the issue/pull request is currently unable to move forward because
of some specific reason, generally this will be a reason that is outside
about solving it.
* <b>working</b> - An issue that has a specific invidual assigned to and planning
to do work on it.
* <b>user feedback required</b> - The issue/pull request is blocked pending more
feedback from an end user
* <b>blocked / backlog</b> - the issue/pull request is currently unable to move forward
because of some specific reason, generally this will be a reason that is outside
RubyGems or needs feedback from some specific individual or group, and it may
be a while before something it is resolved.

Feedback and blocked all have the same color since they are all waiting on
someone in particular to do something.

=== Inactive Reason
=== Closed Reason

Reasons are why an issue / pull request was closed without being worked on or
accepted. There should also be more detailed information in the comments.
accepted. There should also be more detailed information in the comments. The
closed reason labels are maroon <tt>closed: *</tt>.

* *duplicate* - This is a duplicate of an existing bug. The comments must
reference the existing issue.
Expand All @@ -100,32 +106,25 @@ accepted. There should also be more detailed information in the comments.
is not accepted.
* *deprecated* - An issue/pull request that no longer applies to the actively
maintained codebase.

All the reason labels are the same maroon color.
* *discussion* - An issue/pull that is no longer about a concrete change, and
is instead being used for discussion.

=== Categories

These are aspects of the codebase, or what general area the issue or pull
request pertains too. Not all issues will have a category.
request pertains too. Not all issues will have a category. All categorized
issues have a blue <tt>category: *</tt> label.

* <b>gemspec</b> - related to the gem specification itself
* <b>API</b> - related to the public supported rubygems API. This is the code api,
* *gemspec* - related to the gem specification itself
* *API* - related to the public supported rubygems API. This is the code api,
not a network related API.
* <b>command</b> - related to something in <tt>Gem::Commands</tt>
* <b>install</b> - related to gem installations
* <b>documentation</b> - related to updating / fixing / clarifying documentation or
* *command* - related to something in <tt>Gem::Commands</tt>
* *install* - related to gem installations
* *documentation* - related to updating / fixing / clarifying documentation or
guides

All category labels are the same blue color.

=== Platforms

If an issue or pull request pertains to only one platform, then it should have
an appropriate platform tag.

* *windows*
* *java*
* *osx*
* *linux*

All platform tags are the same purple color.
an appropriate purle <tt>platform: *</tt> label. Current platform labels:
*windows*, *java*, *osx*, *linux*

0 comments on commit 7fc150a

Please sign in to comment.