This is an automated email from the ASF dual-hosted git repository. jmclean pushed a commit to branch contributing in repository https://gitbox.apache.org/repos/asf/gravitino-site.git
commit 0b66629b0c8c6031764a19ba0281712e0720cf8c Author: Justin Mclean <[email protected]> AuthorDate: Wed Jul 17 08:23:50 2024 +1000 add contributing page --- docusaurus.config.ts | 1 + src/pages/contrib.mdx | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 83 insertions(+) diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 46b73e7..e0d1c21 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -75,6 +75,7 @@ const config: Config = { }, items: [ {to: '/', label: 'Apache Gravitino', position: 'left'}, + {to: '/contrib', label: 'Contributing', position: 'right'}, {type: 'docSidebar', sidebarId: 'docs', position: 'right', label: 'Docs'}, {to: '/blog', label: 'Blog', position: 'right'}, { diff --git a/src/pages/contrib.mdx b/src/pages/contrib.mdx new file mode 100644 index 0000000..ed39bc0 --- /dev/null +++ b/src/pages/contrib.mdx @@ -0,0 +1,82 @@ +# Contributing to Apache Gravitino + +Welcome! We appreciate your interest in contributing to Apache Gravitino. This page provides guidelines and information on how to contribute to Gravitino. Please take a moment to read through this document before getting started. By contributing to this project, you agree to abide by the guidelines outlined below. + +## Table of Contents + +- [Getting Started](#getting-started) +- [How to Contribute](#how-to-contribute) +- [Code Contribution Guidelines](#code-contribution-guidelines) +- [Bug Reports and Feature Requests](#bug-reports-and-feature-requests) +- [Community Guidelines](#community-guidelines) +- [Contact](#contact) +- [License](#license) + +## Getting Started + +To get started with Gravitino, follow these steps: + +1. Fork [the repository](https://github.com/apache/gravitino) on GitHub. +2. Clone the forked repository to your local machine. +3. Set up the development environment as specified in the [README](https://github.com/apache/gravitino/blob/main/README.md). +4. Create a new branch for your contribution. + +## How to Contribute + +1. Check Gravitiuno's [GitHub issue tracker](https://github.com/apache/gravitino/issues) for a list of open issues or features that require attention. +2. If you find an issue or feature you'd like to work on, comment on the issue to let others know you're working on it. This helps prevent duplicate efforts and promotes collaboration. +3. If you have a new idea or want to suggest a change, create a new issue outlining your proposal. Engage in discussion with the community to gather feedback and refine your ideas. +4. Fork the repository and create a new branch for your contribution. Make sure to give your branch a descriptive name related to the issue or feature you're working on. +5. Follow the project's code contribution guidelines to implement your changes or additions. +6. Commit your changes with clear and concise commit messages. +7. Push your changes to your forked repository. +8. Open a pull request (PR) in the [Gravitino repository](https://github.com/apache/gravitino). +9. Engage in the code review process by addressing any review comments and making necessary changes to your code. +10. Once your changes pass the review process, they will be merged into the main repository. + +## Code Contribution Guidelines + +To ensure smooth collaboration and to maintain a high-quality codebase, please adhere to the following guidelines when making code contributions: + +- Follow the existing code style and conventions used in the project. +- Write clear, concise, and well-documented code. This includes providing inline comments when necessary. +- Keep your changes focused and granular. Separate unrelated changes into multiple pull requests. +- Write unit tests for your code changes, whenever applicable, and make sure the existing tests pass successfully. +- Make sure your code compiles without any errors or warnings. +- Avoid introducing unnecessary dependencies. If you need to include a new dependency, justify it and discuss it with the community first. +- Be responsive and open to feedback during the code review process. + +## Bug Reports and Feature Requests + +If you encounter a bug or have a feature request, please follow these steps: + +1. Search [Gravitino's issue tracker](https://github.com/apache/gravitino/issues) to ensure that the bug or feature hasn't been reported before. +2. If not found, create a new issue with a descriptive title and provide detailed information about the bug or feature request. +3. Clearly explain the steps to reproduce the bug, including any relevant error messages or screenshots. +4. If applicable, include suggestions or ideas on how to fix the bug or implement the requested feature. +5. Engage in any discussions or clarifications that arise from the issue. + +## Community Guidelines + +We value and appreciate the diverse contributions and ideas from the community. To maintain a welcoming and inclusive environment, we kindly ask you to adhere to the following guidelines: + +- Be respectful and considerate of other community members. Treat everyone with respect and professionalism. +- Refrain from engaging in offensive, discriminatory, or harassing behavior. +- Be patient and understanding towards others, especially newcomers who may be learning. +- Stay constructive and provide helpful feedback. +- Engage in meaningful and relevant discussions related to the project. +- Avoid spamming, excessive self-promotion, or advertising unrelated content. +- Use clear and concise language to facilitate effective communication. + +## Large Contributions and ICLAs + +For significant contributions to Gravitino, the ASF requires contributors to sign an Individual Contributor License Agreement (ICLA). If you plan to make a large contribution, please email [[email protected]](mailto:[email protected]) to discuss the ICLA process. + +## Developer Mailing List + +If you have any questions or need further assistance, please contact [[email protected]](mailto:[email protected]). + +## License + +Apache Gravitino is licensed under the Apache License version 2. By contributing to this project, you agree to license your contributions under the same license. +
