This is an automated email from the ASF dual-hosted git repository.
loogn pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/geaflow.git
The following commit(s) were added to refs/heads/master by this push:
new e7a53a10 docs: streamline contributing and roles documentation 📚 (#588)
e7a53a10 is described below
commit e7a53a10901b247c4152ceaeaf26795c1dc19c72
Author: 明城 <[email protected]>
AuthorDate: Tue Aug 12 20:08:03 2025 +0800
docs: streamline contributing and roles documentation 📚 (#588)
- Simplify CONTRIBUTING.md with concise steps and prerequisites
- Restructure ROLES.md for clarity and remove redundant content
- Update community links and resources for consistency
Signed-off-by: mingcheng <[email protected]>
---
community/CONTRIBUTING.md | 94 +++++++++++++++--------------------------------
community/ROLES.md | 22 +++--------
2 files changed, 34 insertions(+), 82 deletions(-)
diff --git a/community/CONTRIBUTING.md b/community/CONTRIBUTING.md
index 4ee139b0..c255244d 100644
--- a/community/CONTRIBUTING.md
+++ b/community/CONTRIBUTING.md
@@ -1,79 +1,43 @@
# Contributing to GeaFlow
-Thank you for your interest in contributing to GeaFlow! We welcome all kinds
of contributions and appreciate your support.
-
-## How to Contribute
-
-### 1. Prerequisites
-
-Before you start, make sure you have:
-- Java 11 or above
-- Maven 3.6+
-- Git
-You may also need Docker for some modules.
-
-### 2. Fork the Repository
-Click the "Fork" button on the top right of the [GeaFlow GitHub
page](https://github.com/apache/geaflow).
-
-### 3. Clone Your Fork
-Clone your fork to your local machine:
-```bash
-git clone https://github.com/<your-username>/geaflow.git
-cd geaflow
-```
-
-### 4. Create a Branch
-Create a new branch for your work:
-```bash
-git checkout -b my-feature-branch
-```
-
-### 5. Make Changes
-Edit the code. Please follow the coding style (see below) and add tests if
needed.
-
-### 6. Run Tests
-Run all tests to make sure your changes work:
-```bash
-mvn clean install
-```
-Fix any issues before submitting your changes.
-
-### 7. Commit Changes
-Write a clear commit message:
-```bash
-git add .
-git commit -m "[Module] Brief description of your changes"
-```
-
-### 8. Push Changes
-Push your branch to your fork:
-```bash
-git push origin my-feature-branch
-```
-
-### 9. Create a Pull Request
-Go to your fork on GitHub and click "New Pull Request". Fill in a clear title
and description. Link related issues if any.
-
-### 10. Review Process
-Project maintainers will review your pull request. Please respond to feedback
and make changes if needed.
+Thank you for your interest in contributing to GeaFlow! We welcome all
contributions and appreciate your support.
-## Code of Conduct
+## Ways to Contribute
+
+There are many ways to contribute to GeaFlow, and not all of them involve
writing code. All forms of participation are valuable and help grow a healthy
community. Here are some examples of how you can help:
+
+- Answering questions and helping others in our community spaces (mailing
list, GitHub Discussions, etc.).
+- Reporting bugs, suggesting new features, or sharing your feedback.
+- Reviewing and testing pull requests from other contributors.
+- Translating documentation or other project materials.
+- Organizing or promoting community events.
+- Improving our project website, design, or user experience.
+- Creating tutorials, blog posts, or videos to help others learn about GeaFlow.
+- Spreading the word about GeaFlow through outreach and advocacy.
+- Any other activity that helps the project and its users!
-Please follow our [Code of Conduct](../CODE_OF_CONDUCT.md) in all project
interactions.
+If you have an idea for a contribution, please share it with the community.
Every contribution is welcome!
+
+## Code of Conduct
+Please follow our [Code of Conduct](../CODE_OF_CONDUCT.md) in all your
interactions with the project.
## Coding Style
-Please follow the Java style in `tools/intellij-java-style.xml` and checkstyle
rules in `tools/checkstyle.xml`. You can use IDE plugins to auto-format code.
+
+Please follow the Java style defined in `tools/intellij-java-style.xml` and
the checkstyle rules in `tools/checkstyle.xml`. You can use IDE plugins to
automatically format your code.
## Reporting Issues
-If you find a bug or have a feature request, please open an issue on [GitHub
Issues](https://github.com/apache/geaflow/issues) with clear steps to reproduce
or describe your suggestion.
+
+If you find a bug or have a feature request, please open an issue on our
[GitHub Issues](https://github.com/apache/geaflow/issues). Provide clear steps
to reproduce the bug or a detailed description of your suggestion.
## Documentation
-See the [docs folder](../docs) for user and developer documentation.
+
+Our user and developer documentation can be found in the [docs
folder](../docs). We welcome any improvements you can make!
## Community
-- [Issue Tracker](https://github.com/apache/geaflow/issues)
-- [Mailing List](https://geaflow.apache.org/community.html)
-- [Website](https://geaflow.apache.org/)
-Thank you for helping improve GeaFlow!
+- **Website**: [https://geaflow.apache.org/](https://geaflow.apache.org/)
+- **Issue Tracker**:
[https://github.com/apache/geaflow/issues](https://github.com/apache/geaflow/issues)
+- **Mailing List**: [[email protected]](mailto:[email protected])
+
+Thank you for helping us improve GeaFlow!
diff --git a/community/ROLES.md b/community/ROLES.md
index 09801b31..b8d56720 100644
--- a/community/ROLES.md
+++ b/community/ROLES.md
@@ -5,20 +5,17 @@
- [Users](#users)
- [Contributors](#contributors)
- [Committers](#committers)
- - [Project Management Committee (PMC)](#project-management-committee-pmc)
- [The Apache Way](#the-apache-way)
This project follows the [Apache Software Foundation (ASF) Governance
Ladder](https://theapacheway.com/ladder/). Below are the main roles, how to
move between them, and their responsibilities.
## Role Overview
-| Role | Level | Key Requirements | Main
Responsibilities |
-| ------------ | ---------- | -------------------------------- |
--------------------------------- |
-| Users | Entry | Use GeaFlow | Report
issues, provide feedback |
-| Contributors | Active | Submit PRs/issues | Code
contributions, documentation |
-| Committers | Trusted | Consistent quality contributions | Review code,
merge PRs, mentor |
-| PMC Members | Leadership | Elected by PMC | Project
governance, releases |
-
+| Role | Level | Key Requirements | Main
Responsibilities |
+| ------------ | ------- | -------------------------------- |
--------------------------------- |
+| Users | Entry | Use GeaFlow | Report issues,
provide feedback |
+| Contributors | Active | Submit PRs/issues | Code
contributions, documentation |
+| Committers | Trusted | Consistent quality contributions | Review code,
merge PRs, mentor |
### Users
**Who:** Anyone who uses GeaFlow.
@@ -49,16 +46,7 @@ This project follows the [Apache Software Foundation (ASF)
Governance Ladder](ht
- Help and mentor new contributors.
- Follow ASF and project policies.
-### Project Management Committee (PMC)
-**Who:** Committers who are responsible for the overall project management.
Members are elected by the current PMC.
-
-**How to become:** The PMC votes to add new members from the pool of active
committers.
-**Responsibilities:**
-- Set project direction and policies.
-- Approve releases.
-- Ensure the project follows the Apache Way and ASF rules.
-- Handle legal, security, and community issues.
## The Apache Way
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
