This is an automated email from the ASF dual-hosted git repository.
yiconghuang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/texera.git
The following commit(s) were added to refs/heads/master by this push:
new b98a47798c chore(doc): update CONTRIBUTING.md (#3611)
b98a47798c is described below
commit b98a47798c74655f165678cdeb9bf8e7a9476eeb
Author: Yicong Huang <[email protected]>
AuthorDate: Thu Aug 7 23:02:41 2025 -0700
chore(doc): update CONTRIBUTING.md (#3611)
Modified the documentation to describe different roles of developers and
how a developer in the "contributor" role makes changes to the codebase.
Resolves #3608
---------
Signed-off-by: Yicong Huang <[email protected]>
Co-authored-by: Copilot <[email protected]>
---
CONTRIBUTING.md | 37 ++++++++++++++++++++++++++-----------
1 file changed, 26 insertions(+), 11 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a138a65331..46fa4a504d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,16 +3,29 @@
Thank you for your interest in contributing to Texera! Please follow the steps
below to submit your contributions effectively. We follow a **fork-based
development workflow** and adopt the [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for
commit messages and pull request titles.
---
+## Different roles in the project
-## đź› Contribution Workflow
+| Role | Key Permissions | How to Join
+| -------- | ------- | ------- |
+| Contributor | Submit issues & PRs, join discussions | Start contributing
— no formal process |
+| Committer | Merge PRs, push code, vote on code changes | Voted by PPMC
based on quality contributions |
+| PPMC Member | Governance, vote on releases & new committers/PPMC | Voted
by PPMC members |
+| Mentor | Guide project, oversee releases, ensure Apache policies followed
| Appointed by Incubator PMC — must be an experienced Apache member |
-### 1. Fork and Branch
+## đź› Contribution Steps
+
+### 1. Fork the Repo
- Fork the [Texera repository](https://github.com/Texera/texera) to your own
GitHub account.
-- Create a new branch in your fork for your contribution.
-### 2. Open a Pull Request (PR)
-- Submit a PR from your fork to the original Texera repository.
-- **Check** the option **"Allow edits from maintainers"** so that Texera
committers can make minor edits to your PR if needed.
+### 2. Find an Existing Issue or Open an Issue
+- Find an existing issue that you want to work on, or create one issue for new
proposal/bug description.
+- Have a discussion on the issue with Texera Committers (@Committer).
+- Reach a consensus before you work on the development related to the issue.
+
+### 3. Open a Pull Request (PR)
+- Create a new branch in your fork for your contribution.
+- Once you are done with the development, submit a PR from your fork to the
original Texera repository.
+- **Check** the option **"Allow edits from maintainers"** so that Texera
Committers can make minor edits to your PR if needed.
#### PR Title and Commit Messages
- We require all PR titles and commit messages to follow the [Conventional
Commits spec](https://www.conventionalcommits.org/en/v1.0.0/).
@@ -35,23 +48,25 @@ Your pull request description should include:
- Optional **technical design diagram** or description.
- Optional **GIFs or screenshots** for UI-related changes.
-### 3. Avoid Including Sensitive Information
+#### Avoid Including Sensitive Information
Do not include any of the following in your PR:
- Local configuration files (e.g., `python_udf.conf`)
- Secrets or credentials (e.g., passwords, tokens)
- Build artifacts or binary files
-### 4. Final Steps Before Review
-- [ ] Assign yourself to the PR.
+### 4. PR Review
+- [ ] Ask a Texera Committer (by commenting on the PR) to triage your PR,
i.e., request a reviewer, and assign the PR to you.
- [ ] Add appropriate labels such as `fix`, `enhancement`, `docs`, etc.
-- [ ] Request at least one reviewer.
- [ ] Ensure that all CI checks pass (see [GitHub
Actions](https://github.com/Texera/texera/actions)).
- [ ] Fully test your changes locally.
-- [ ] Wait for a Texera committer to merge the PR once it is approved.
> ℹ️ If your PR is not ready for review, please mark it as a draft. You can
> change it to “Ready for review” when it is complete.
+### 5. After PR Approval
+- [ ] Wait for a Texera Committer, usually the reviewer, to merge the PR once
it is approved.
+- [ ] Close the related issue once the PR is merged (if it is not
automatically closed).
+
---
## đź“ť Apache License Header
