Skip to content

Conversation

@p0fi
Copy link
Collaborator

@p0fi p0fi commented Oct 7, 2025

📖 Description

This pull request adds a comprehensive CONTRIBUTING.md guide for the Matter Handbook, outlining the contribution process, workflow, and merge conditions. The new documentation clarifies how contributors should submit changes, how reviews and approvals work, and the roles involved in maintaining quality and domain expertise.

Contribution Process and Workflow

  • Added a detailed summary of the PR-based contribution workflow, specifying that all changes (including minor edits) must go through pull requests for review and automation.
  • Documented the branching strategy for frequent and infrequent contributors, including branch naming conventions and cleanup practices.

Labels and Merge Conditions

  • Defined label usage (editorial, tooling, domain labels, do not merge) and the gates required for each, including the requirement for subject-matter expert approval on domain changes.
  • Listed all mandatory merge conditions, such as maintainer approval, successful automated checks, and absence of unresolved review threads or blocking labels.

Roles and Review Discipline

  • Clarified the responsibilities of authors, maintainers, and SMEs, and provided guidance on review discipline and escalation procedures if a PR is blocked.

📋 TODO

After the SC approves the process, the following tasks still need to be completed in follow-up PRs or as administrative work on GitHub:

  • Clean up contributor groups
  • Create SME groups
  • Add label-based automation to:
    • Request reviews
    • Check for approvals
  • Add Mergify configuration
  • Create labels

p0fi added 2 commits October 7, 2025 16:46
Adding a CONTRIBUTING.md file that outlines the editorial process for adding new content or modifying the existing Matter Handbook content.
@github-actions
Copy link

github-actions bot commented Oct 7, 2025

Preview deployed at https://d2doqw88td69eq.cloudfront.net/pr-103

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a comprehensive CONTRIBUTING.md file, which is a great addition for clarifying the contribution process. The document is well-structured and covers all the essential aspects of the workflow. My review includes a few suggestions to correct some typos, improve grammatical correctness, and enhance overall clarity and consistency, which will help make the guide even more effective for contributors.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@github-actions
Copy link

github-actions bot commented Oct 7, 2025

Preview deployed at https://d2doqw88td69eq.cloudfront.net/pr-103

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@github-actions
Copy link

github-actions bot commented Oct 7, 2025

Preview deployed at https://d2doqw88td69eq.cloudfront.net/pr-103

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.

1 participant