Skip to content

Commit 6db5127

Browse files
committed
Clarify things not to do
1 parent 25cd35e commit 6db5127

File tree

1 file changed

+7
-18
lines changed

1 file changed

+7
-18
lines changed

docs/contributing/first-time.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,29 +40,18 @@ This section first discusses what not to do, then how to work effectively with a
4040
The following is a list of the most frequent mistakes made by first-time contributors.
4141
Learn from their mistakes, and don't commit them yourself.
4242

43+
(mistake-1-label)=
44+
4345
1. **Never ask to be assigned to an issue.**
46+
Instead you may post a comment to claim it, if no one else has claimed it (see {ref}`Avoid duplicate effort <mistake-2-label>`).
47+
For example, "I am working on this issue in pull request #123."
4448
You do not need to ask to be assigned to, or to work on, an open issue.
4549
As in any open source software project, you can start work on open issues at your convenience.
46-
Privileged team members may ignore or delete such comments.
47-
48-
1. **Never edit an issue description that you did not create.**
49-
The issue description is the first comment in the issue.
50-
Editing the description is destructive behavior.
51-
If the description is not clear, then ask the author to clarify it.
52-
53-
```{todo}
54-
Verify whether Contributors members can still do this.
55-
```
50+
Privileged team members may ignore or delete comments asking to be assigned to an issue.
5651

57-
1. **Never close another contributor's pull request.**
58-
This is extremly rude and disrespectful behavior.
59-
Only members of privileged GitHub teams should close pull requests.
60-
61-
```{todo}
62-
Verify whether Contributors members can still do this.
63-
```
52+
(mistake-2-label)=
6453

65-
1. **Avoid duplicate effort.**
54+
2. **Avoid duplicate effort.**
6655
Don't work on issues that have already been claimed or worked on, unless such effort has been abandoned by the author.
6756
GitHub's interface provides links to related issues and pull requests, and who is assigned to an issue.
6857
Pull requests will be reviewed in the order received.

0 commit comments

Comments
 (0)