You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 23092be
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-5Lines changed: 13 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ By participating you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
7
7
## Ways to contribute
8
8
9
9
> [!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.
11
11
> While we value good intentions, we require approvals for community code contributions to ensure we use everyone's time effectively.
12
12
13
13
-**Report bugs** — open an issue with steps to reproduce, expected vs actual behavior, and your environment.
@@ -18,16 +18,24 @@ For security vulnerabilities, do **not** open a public issue — see [SECURITY.m
18
18
19
19
### Why we require approvals for community code contributions
20
20
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
+
21
24
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.
22
25
23
26
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.
24
27
25
28
For these reasons, we focus community contributions on issue reports, analysis, and feedback, over larger code changes.
|[`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. |
30
-
|`needs-maintainer-approval`| Proposal is still awaiting maintainer review; contributors should not start implementation yet. |
30
+
> [!Note]
31
+
> 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.
|[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. |
0 commit comments