From bc9079ff5513de751d391b4eabf37752e13cbf9f Mon Sep 17 00:00:00 2001 From: Shipeng Qi Date: Sat, 16 Nov 2024 11:58:03 +0800 Subject: [PATCH] [DOC]: Add community governance guidelines (#754) --- CODE_OF_CONDUCT.md | 74 +++++++++++++++++++++++++++++++++++++++ community/CONTRIBUTING.md | 52 +++++++++++++++++++++++++++ community/ROLES.md | 44 +++++++++++++++++++++++ 3 files changed, 170 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 community/CONTRIBUTING.md create mode 100644 community/ROLES.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..8b2187a902 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community includes using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting opensource@github.com, which is a shared team inbox. If the incident involves someone who receives that shared inbox, you can contact an individual maintainer @qishipengqsp at qishipengqsp@gmail.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [https://contributor-covenant.org/version/1/4][version] + +[homepage]: https://contributor-covenant.org +[version]: https://contributor-covenant.org/version/1/4/ diff --git a/community/CONTRIBUTING.md b/community/CONTRIBUTING.md new file mode 100644 index 0000000000..7173e8b8ab --- /dev/null +++ b/community/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# Contributing to TuGraph DB + +Thank you for considering contributing to TuGraph DB! We welcome contributions from the community and are grateful for your support. + +## How to Contribute + +### 1. Fork the Repository +Fork the repository to your own GitHub account by clicking the "Fork" button at the top right of the repository page. + +### 2. Clone the Repository +Clone the forked repository to your local machine: +```bash +git clone https://github.com/TuGraph-family/tugraph-db.git +cd tugraph-db +``` + +### 3. Create a Branch +Create a new branch for your feature or bugfix: +```bash +git checkout -b my-feature-branch +``` + +### 4. Make Changes +Make your changes to the codebase. Ensure your code follows the project's coding standards and includes appropriate tests. + +### 5. Commit Changes +Commit your changes with a clear and concise commit message: +```bash +git add . +git commit -m "Description of your changes" +``` + +### 6. Push Changes +Push your changes to your forked repository: +```bash +git push origin my-feature-branch +``` + +### 7. Create a Pull Request +Create a pull request from your forked repository to the main repository. Provide a detailed description of your changes and any relevant information. + +### 8. Review Process +Your pull request will be reviewed by the project maintainers. Please be responsive to any feedback or requests for changes. + +## Code of Conduct +Please adhere to our [Code of Conduct](../CODE_OF_CONDUCT.md) in all your interactions with the project. + +## Additional Resources +- [Issue Tracker](https://github.com/TuGraph-family/tugraph-db/issues) +- [Project Documentation](../docs) + +Thank you for your contributions! diff --git a/community/ROLES.md b/community/ROLES.md new file mode 100644 index 0000000000..7011e6d866 --- /dev/null +++ b/community/ROLES.md @@ -0,0 +1,44 @@ +# Roles and Responsibilities + +## Project Roles + +### Project Management Committee (PMC) +- **Description**: The PMC is responsible for the overall management and oversight of the project. +- **Responsibilities**: + - Ensure the project adheres to the Apache Way. + - Make decisions regarding project direction and policies. + - Manage releases and ensure quality standards are met. + - Handle legal and licensing issues. + +### Committers +- **Description**: Committers are contributors who have earned the right to commit code directly to the project repository. +- **Responsibilities**: + - Review and commit code contributions from the community. + - Maintain the project's codebase and documentation. + - Mentor new contributors and facilitate their integration into the project. + - Ensure contributions adhere to project guidelines and standards. + +### Contributors +- **Description**: Contributors are individuals who contribute to the project by submitting patches, documentation, or other improvements. +- **Responsibilities**: + - Submit patches and improvements via pull requests. + - Participate in discussions and provide feedback on issues and proposals. + - Follow the project's contribution guidelines and coding standards. + - Engage with the community and assist other contributors. + +### Users +- **Description**: Users are individuals or organizations that use the project. +- **Responsibilities**: + - Provide feedback and report issues. + - Participate in the community by asking questions and sharing experiences. + - Contribute to the project's documentation and knowledge base. + +## The Apache Way + +The project follows the principles of the Apache Way, which include: +- **Community Over Code**: Prioritizing a healthy and vibrant community over the code itself. +- **Meritocracy**: Recognizing and rewarding contributions based on merit. +- **Openness**: Conducting all project discussions and decisions in public forums. +- **Consensus**: Striving for consensus in decision-making processes. + +For more information on the Apache Way, please refer to the [Apache Software Foundation](https://www.apache.org/foundation/how-it-works.html).