Skip to content

Commit 1906fcd

Browse files
Fixes #446: Clarify contribution approval labels in the docs (#449)
* docs: clarify contribution approval labels * Add a tip section about needs maintainer attention label --------- Co-authored-by: Chirag Jain <jain.chirag925@gmail.com>
1 parent 3539da2 commit 1906fcd

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

‎CONTRIBUTING.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ By participating you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
77
## Ways to contribute
88

99
> [!Important]
10-
> Please only submit pull requests if you have received approval from a maintainer.
10+
> Please only submit pull requests for an issue when you have received approval from a maintainer.
1111
> While we value good intentions, we require approvals for community code contributions to ensure we use everyone's time effectively.
1212
1313
- **Report bugs** — open an issue with steps to reproduce, expected vs actual behavior, and your environment.
@@ -18,6 +18,9 @@ For security vulnerabilities, do **not** open a public issue — see [SECURITY.m
1818

1919
### Why we require approvals for community code contributions
2020

21+
> [!Tip]
22+
> Every new issue by default is labelled with [needs-maintainer-attention](https://github.com/truefoundry/trueforge/issues?q=is%3Aissue%20state%3Aopen%20label%3Aneeds-maintainer-attention). A maintainer will review the issue and discuss the next steps. Please don't remove this label while creating the issue.
23+
2124
Effective changes to TrueForge require architectural context, an understanding of system-level constraints, and visibility into the project's roadmap. Community pull requests often focus on issues that are lower priority, affect a small number of users, or need substantial changes to fit the broader system. Reviewing and iterating on those changes can take more time than implementing a fix directly, diverting attention from higher-priority work.
2225

2326
Community expertise is most valuable when shared through detailed bug reports, reproduction steps, logs, root-cause analysis, and design discussions in issues. Understanding the problem, identifying the right solution, and prioritizing the work are typically the hard parts; implementation is comparatively straightforward with coding assistants.
@@ -27,6 +30,13 @@ For these reasons, we focus community contributions on issue reports, analysis,
2730
> [!Note]
2831
> If you would still like to contribute code, we keep a dedicated set of issues marked as [help-wanted](https://github.com/truefoundry/trueforge/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22) that are well scoped.
2932
33+
### Issue labels
34+
35+
| Label | Meaning |
36+
| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
37+
| [help-wanted](https://github.com/truefoundry/trueforge/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22) | Well-scoped issue where community contributions are welcome. |
38+
| [needs-maintainer-attention](https://github.com/truefoundry/trueforge/issues?q=is%3Aissue%20state%3Aopen%20label%3Aneeds-maintainer-attention) | Issue needs discussion with maintainers before implementation can start. |
39+
3040
### Reporting bugs
3141

3242
Before opening a new issue, search the issue tracker to see whether the problem has already been reported. If it has, add any new information to the existing issue.

0 commit comments

Comments
 (0)