Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs to match the new triague guidelines #4260

Merged
merged 3 commits into from
Sep 6, 2018
Merged

Update docs to match the new triague guidelines #4260

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
00fd2ef
Update docs to match the new triague guidelines
stsewd Jun 18, 2018
3cb3dc2
Remove old label Feature overview
stsewd Aug 16, 2018
ff0ffd8
Describe label: Improvement
stsewd Aug 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 5 additions & 24 deletions docs/contribute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,7 @@ label. The reported issue …
in the past or it was decided that the proposed feature will not be
implemented because it does not conform with the overall goal of Read the
Docs. Also if you happen to know that the problem was already reported,
label the ticket with **Status: duplicate**, reference the other ticket
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have the duplicate label anymore

that is already addressing the problem and close the duplicate.
reference the other ticket that is already addressing the problem and close the duplicate.

Examples:

Expand Down Expand Up @@ -140,18 +139,16 @@ label. The reported issue …
- *My builds stopped working. Please help!*
Ask for a link to the build log and for which project is affected.

… is a valid enhancement proposal
If the ticket contains an enhancement proposal that aligns with the goals
of Read the Docs, then add the label **Enhancement**. If the proposal
… is a valid feature proposal
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think enhancement is now feature, but we also have Improvement (that's why I removed some examples here)

If the ticket contains a feature that aligns with the goals
of Read the Docs, then add the label **Feature**. If the proposal
seems valid but requires further discussion between core contributors
because there might be different possibilities on how to implement the
enhancement, then also add the label **Needed: design decision**.
feature, then also add the label **Needed: design decision**.

Examples:

- *Improve documentation about MKdocs integration*
- *Provide better integration with service XYZ*
- *Refactor module X for better readability*
- *Achieve world domination* (also needs the label **Needed: design
decision**)

Expand Down Expand Up @@ -208,14 +205,6 @@ few more at hand to further categorize issues.
If the issue is urgent, assign this label. In the best case also go forward to
resolve the ticket yourself as soon as possible.

*Community Effort*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We still have this label. :/ The other PR doesn't actually refer to removing it, it just removed it (unless I am missing something?)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, here is a little of discussion #4180 (comment) and the commit d981892

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I saw that discussion and the commit; it just doesn't seem like dropping the 'Community Effort' label was discussed, it was just included in the commit.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've already started retriaging these issues, but yes, there are still some left. I'm +1 on just removing from the docs for now.

There are many valuable ideas in the issue tracker for future enhancements
of Read the Docs. Unfortunately too many for the core developers to handle
all of them. Therefore we assign the *Community Effort* label on all the
issues that we see as valid for the project but that we currently do not
have the resources to work on. We encourage community members to work
on these tickets and to submit a pull request.

*Good First Issue*
This label marks tickets that are easy to get started with. The ticket
should be ideal for beginners to dive into the code base. Better is if the
Expand All @@ -225,14 +214,6 @@ few more at hand to further categorize issues.
Sprintable are all tickets that have the right amount of scope to be
handled during a sprint. They are very focused and encapsulated.

*Feature Overview*
If a feature is too big to be tackled in one ticket and should be split
up, then we have a feature overview ticket explaining the overarching
idea. Those tickets related to one feature should also be grouped by a
`milestone`_.

.. _milestone: https://github.com/rtfd/readthedocs.org/milestones

For a full list of available labels and their meanings, see
:doc:`issue-labels`.

Expand Down