Skip to content

docs(contributing): document the take and untake issue commands #4043

Description

@jackeyfaker77

Problem

CONTRIBUTING.md and CONTRIBUTING.zh-CN.md tell contributors to claim an
issue in a comment, but they do not document the repository's exact
self-assignment commands.

The workflow in .github/workflows/take.yml only runs when the complete
comment body is exactly take or untake. A natural-language comment such as
“I'd like to work on this issue” therefore does not assign the contributor and
does not explain why nothing happened.

The self-assignment behavior was introduced by #3774 for #3773, but its
user-facing commands are currently only discoverable by reading the workflow
or the old issue.

Desired outcome

Update both contribution guides to document that:

  • a standalone take comment self-assigns an unclaimed issue;
  • a standalone untake comment removes the contributor's assignment;
  • other claim text does not trigger the workflow.

Keep the English and Chinese guides synchronized. This issue does not propose
changing the workflow behavior.

Alternatives or workarounds

Contributors can discover the commands by reading
.github/workflows/take.yml or the closed implementation issue, but the
contribution guide should explain the supported claim mechanism directly.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions