Skip to content

Commit 7e86a56

Browse files
committed
improve CONTRIBUTING guide
1 parent 7c470bc commit 7e86a56

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

CONTRIBUTING.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ Contributions to the project are made through GitHub pull requests (PRs) that co
1717

1818
### 2. Claiming a Task
1919

20-
- To claim a task, comment `claim` on the relevant GitHub issue.
20+
- To claim a task, comment the single word `claim` on the relevant GitHub issue.
2121
- If no other user is assigned, you will automatically be assigned to the task, and the issue will move to the `Claimed` column.
22-
- You may only claim one task at a time. If you decide not to work on a task after claiming it, comment `disclaim` on the issue. This will unassign you and return the issue to the `Unclaimed` column, making it available for others to claim.
22+
- You may only claim one task at a time. If you decide not to work on a task after claiming it, comment the single word `disclaim` on the issue. This will unassign you and return the issue to the `Unclaimed` column, making it available for others to claim.
2323

2424
### 3. Working on the Task
2525

@@ -28,17 +28,17 @@ Once you are assigned to an issue, begin working on the corresponding task. You
2828
### 4. Submitting a Pull Request
2929

3030
- When you are ready to submit your solution, create a PR from your working branch to the project’s `main` branch.
31-
- After submitting the PR, comment `propose PR #PR_NUMBER` on the original issue. This links your PR to the task, and the task will move to the `In Progress` column on the dashboard.
31+
- After submitting the PR, comment the single phrase `propose PR #PR_NUMBER` on the original issue. This links your PR to the task, and the task will move to the `In Progress` column on the dashboard.
3232
- A task can only move to `In Progress` if it has been claimed by the user proposing the PR.
3333

3434
### 5. Withdrawing or Updating a PR
3535

36-
- If you need to withdraw your PR, comment `withdraw PR #PR_NUMBER` on the issue. The task will return to the `Claimed` column, but you will remain assigned to the issue.
37-
- To submit an updated PR after withdrawal, comment `propose PR #NEW_PR_NUMBER` following the same process outlined in step 4.
36+
- If you need to withdraw your PR, comment the single phrase `withdraw PR #PR_NUMBER` on the issue. The task will return to the `Claimed` column, but you will remain assigned to the issue.
37+
- To submit an updated PR after withdrawal, comment the single phrase `propose PR #NEW_PR_NUMBER` following the same process outlined in step 4.
3838

3939
### 6. Review Process
4040

41-
- After finishing the task and ensuring your PR is ready for review, comment `awaiting-review` on the PR. This will add the `awaiting-review` label to your PR and move the task from `In Progress` to the `In Review` column of the dashboard.
41+
- After finishing the task and ensuring your PR is ready for review, comment the single word `awaiting-review` on the PR. This will add the `awaiting-review` label to your PR and move the task from `In Progress` to the `In Review` column of the dashboard.
4242
- The project maintainers will review the PR. They may request changes, approve the PR, or provide feedback.
4343

4444
### 7. Task Completion

0 commit comments

Comments
 (0)