Skip to content

Fixes #446: Clarify contribution approval labels in the docs - #449

Merged
chiragjn merged 2 commits into
truefoundry:mainfrom
rohanmalhotracodes:docs
Aug 26, 2026
Merged

chiragjn merged 2 commits into
truefoundry:mainfrom
rohanmalhotracodes:docs

Conversation

@rohanmalhotracodes

@rohanmalhotracodes rohanmalhotracodes commented Aug 26, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Clarifies how repository labels relate to the maintainer approval process for community code contributions.

Closes #446

Changes

  • Clarified that help-wanted issues are open to community contributions.
  • Clarified that needs-maintainer-approval issues should not be implemented until reviewed.

How was this tested?

  • Ran pnpm prettier --check CONTRIBUTING.md.
  • Ran git diff --check.
  • Pre-commit formatting checks passed.

Checklist

  • I have read the contributing guidelines
  • pnpm build, pnpm test, pnpm typecheck, pnpm lint:ci, and pnpm format:check pass locally
  • Tests added/updated where it makes sense (not applicable for this documentation-only change)
  • No hand-edits to generated code (packages/trueforge-sdk, .github/fern/openapi/openapi.json, docs/openapi.json) — fork PRs omit SDK regen; maintainers regenerate after merge
  • Docs / .env.example updated if configuration or behavior changed

Note

Low Risk
Documentation-only change to contribution guidelines; no runtime or security impact.

Overview
Updates CONTRIBUTING.md so contributors understand when maintainer approval is required and how GitHub issue labels map to that process.

The important callout now says to open PRs for an issue only after a maintainer has approved work, not just “don’t submit PRs without approval” in the abstract. A new tip explains that new issues are labeled needs-maintainer-attention by default (matching the issue templates), that maintainers will triage them, and that contributors should not remove that label.

A new Issue labels table documents help-wanted (community code welcome) versus needs-maintainer-attention (discuss with maintainers before implementing). Closes #446.

Reviewed by Cursor Bugbot for commit 23092be. Bugbot is set up for automated code reviews on this repo. Configure here.

@changeset-bot

changeset-bot Bot commented Aug 26, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 23092be

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@chiragjn
chiragjn enabled auto-merge (squash) August 26, 2026 18:16
@chiragjn
chiragjn merged commit 1906fcd into truefoundry:main Aug 26, 2026
7 checks passed
@rohanmalhotracodes
rohanmalhotracodes deleted the docs branch August 27, 2026 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify contributor labels and approval workflow in CONTRIBUTING.md

2 participants