mirror of https://github.com/zulip/zulip.git
contributor docs: Clarify how to find abandoned issues.
This commit is contained in:
parent
892d9f2443
commit
46a0c6507c
|
@ -134,9 +134,14 @@ repository](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3
|
||||||
alone.
|
alone.
|
||||||
|
|
||||||
You can look through issues tagged with the "help wanted" label, which is used
|
You can look through issues tagged with the "help wanted" label, which is used
|
||||||
to indicate the issues that are ready for contributions. Some repositories also
|
to indicate the issues that are open for contributions. You'll be able to claim
|
||||||
use the "good first issue" label to tag issues that are especially approachable
|
unassigned issues, which you can find using the `no:assignee` filter in GitHub.
|
||||||
for new contributors.
|
You can also pick up issues that are assigned but are no longer being worked on.
|
||||||
|
|
||||||
|
Some repositories use the "good first issue" label to tag issues that are
|
||||||
|
especially approachable for new contributors.
|
||||||
|
|
||||||
|
Here are some handy links for issues to look through:
|
||||||
|
|
||||||
- [Server and web app](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
|
- [Server and web app](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
|
||||||
- Mobile apps: no "help wanted" label, but see the
|
- Mobile apps: no "help wanted" label, but see the
|
||||||
|
@ -155,21 +160,29 @@ changes to tests).
|
||||||
|
|
||||||
We recommend the following process for finding an issue to work on:
|
We recommend the following process for finding an issue to work on:
|
||||||
|
|
||||||
1. Read the description of an issue tagged with the "help wanted" label and make
|
1. Find an issue tagged with the "help wanted" label that is either unassigned,
|
||||||
sure you understand it.
|
or looks to be abandoned.
|
||||||
2. If it seems promising, poke around the product
|
1. Read the description of the issue and make sure you understand it.
|
||||||
|
1. If it seems promising, poke around the product
|
||||||
(on [chat.zulip.org](https://chat.zulip.org) or in the development
|
(on [chat.zulip.org](https://chat.zulip.org) or in the development
|
||||||
environment) until you know how the piece being
|
environment) until you know how the piece being
|
||||||
described fits into the bigger picture. If after some exploration the
|
described fits into the bigger picture. If after some exploration the
|
||||||
description seems confusing or ambiguous, post a question on the GitHub
|
description seems confusing or ambiguous, post a question on the GitHub
|
||||||
issue, as others may benefit from the clarification as well.
|
issue, as others may benefit from the clarification as well.
|
||||||
3. When you find an issue you like, try to get started working on it. See if you
|
1. When you find an issue you like, try to get started working on it. See if you
|
||||||
can find the part of the code you'll need to modify (`git grep` is your
|
can find the part of the code you'll need to modify (`git grep` is your
|
||||||
friend!) and get some idea of how you'll approach the problem.
|
friend!) and get some idea of how you'll approach the problem.
|
||||||
4. If you feel lost, that's OK! Go through these steps again with another issue.
|
1. If you feel lost, that's OK! Go through these steps again with another issue.
|
||||||
There's plenty to work on, and the exploration you do will help you learn
|
There's plenty to work on, and the exploration you do will help you learn
|
||||||
more about the project.
|
more about the project.
|
||||||
|
|
||||||
|
An assigned issue can be considered abandoned if:
|
||||||
|
|
||||||
|
- There is no recent contributor activity.
|
||||||
|
- There are no open PRs, or an open PR needs work in order to be ready for
|
||||||
|
review. For example, a PR may need to be updated to address reviewer feedback
|
||||||
|
or to pass tests.
|
||||||
|
|
||||||
Note that you are _not_ claiming an issue while you are iterating through steps
|
Note that you are _not_ claiming an issue while you are iterating through steps
|
||||||
1-4. _Before you claim an issue_, you should be confident that you will be able to
|
1-4. _Before you claim an issue_, you should be confident that you will be able to
|
||||||
tackle it effectively.
|
tackle it effectively.
|
||||||
|
@ -204,9 +217,10 @@ are set up with a GitHub workflow bot called
|
||||||
requests in order to create a better workflow for Zulip contributors.
|
requests in order to create a better workflow for Zulip contributors.
|
||||||
|
|
||||||
To claim an issue in these repositories, simply post a comment that says
|
To claim an issue in these repositories, simply post a comment that says
|
||||||
`@zulipbot claim` to the issue thread. If the issue is tagged with a [help
|
`@zulipbot claim` to the issue thread. If the issue is [tagged with a help
|
||||||
wanted](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
|
wanted label and is not assigned to someone
|
||||||
label, Zulipbot will immediately assign the issue to you.
|
else](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+no%3Aassignee),
|
||||||
|
Zulipbot will immediately assign the issue to you.
|
||||||
|
|
||||||
Note that new contributors can only claim one issue until their first pull request is
|
Note that new contributors can only claim one issue until their first pull request is
|
||||||
merged. This is to encourage folks to finish ongoing work before starting
|
merged. This is to encourage folks to finish ongoing work before starting
|
||||||
|
|
Loading…
Reference in New Issue