This is an automated email from the ASF dual-hosted git repository. ritesh pushed a commit to branch kerneltime-patch-1 in repository https://gitbox.apache.org/repos/asf/ozone-site.git
commit f71bc779b8dea3fc1b9b01f22384dbb33c0598ea Author: Ritesh H Shukla <[email protected]> AuthorDate: Fri Mar 14 05:32:38 2025 -0700 Update how-to-contribute.md LLM Generated, human edited How to Contribute page. --- src/pages/community/how-to-contribute.md | 139 +++++++++++++++++++++++++++++-- 1 file changed, 130 insertions(+), 9 deletions(-) diff --git a/src/pages/community/how-to-contribute.md b/src/pages/community/how-to-contribute.md index 198065aa..24bf69f5 100644 --- a/src/pages/community/how-to-contribute.md +++ b/src/pages/community/how-to-contribute.md @@ -1,12 +1,133 @@ -# How to Contribute +# How to Contribute to Apache Ozone -**TODO [HDDS-9869](https://issues.apache.org/jira/browse/HDDS-9869) Fill in this page.** +Thank you for your interest in contributing to Apache Ozone! This guide will help you understand the various ways you can contribute to the project and how to get started. -This may end up similar to CONTRIBUTING.md in the Ozone repo, but should document all the ways to contribute outside of code as well. +## Quick Links -- Testing and filing issues - - This may link to the [Report an Issue](report-an-issue) page. -- Contributing code - - Both Ozone backend and Recon UI/UX front end. -- Contributing to the website -- Graphic design work for logos or diagrams. +- [GitHub Repository](https://github.com/apache/ozone) +- [CONTRIBUTING.md](https://github.com/apache/ozone/blob/master/CONTRIBUTING.md) - Detailed contribution guidelines +- [Newbie Jira Issues](https://issues.apache.org/jira/issues/?filter=12353868) - Good first issues for new contributors +- [GitHub Discussions](https://github.com/apache/ozone/discussions) - Engage with the community +- [Ozone Website](https://ozone.apache.org/) - Project documentation +- [Slack Channel](http://s.apache.org/slack-invite) - Join #ozone on ASF Slack + +## Ways to Contribute + +Apache Ozone welcomes contributions in many forms, not just code. Here are various ways you can contribute: + +### 1. Code Contributions + +#### Finding Issues to Work On +- **Newbie Issues**: Start with [beginner-friendly issues](https://issues.apache.org/jira/issues/?filter=12353868) that are good entry points +- **All Open Issues**: Browse [unassigned Jira issues](https://s.apache.org/OzoneUnassignedJiras) to find something that matches your interests and skills + +#### Making Code Changes +1. **Set Up Development Environment** + - Fork and clone the repository + - Enable the `build-branch` GitHub Actions workflow in your fork + +2. **Create a Branch** + - Ensure a Jira issue exists for your task (e.g., HDDS-1234) + - Create a branch for your work: `git checkout -b HDDS-1234` + +3. **Develop Your Changes** + - Follow code style guidelines (2 spaces indentation, 120-char line length) + - Write tests for your changes + - Run relevant checks from `hadoop-ozone/dev-support/checks/` directory + +4. **Submit Your Contribution** + - Push changes to your fork + - Wait for the `build-branch` workflow to complete + - Create a pull request with a clear description + - Update the Jira issue status to "Patch Available" + +### 2. Documentation + +- **Website Improvements**: Contribute to the [Ozone website](https://ozone.apache.org/) - see [instructions](https://cwiki.apache.org/confluence/display/OZONE/Modifying+the+Ozone+Website) +- **Developer Docs**: Enhance the [markdown documentation](https://github.com/apache/ozone/tree/master/hadoop-hdds/docs/content) in the source tree +- **Wiki Pages**: Update the [project wiki](https://cwiki.apache.org/confluence/display/OZONE) (request access through [email protected]) + +### 3. Testing + +- **Unit Tests**: Write JUnit tests for Java code +- **Acceptance Tests**: Create Docker + Robot Framework tests +- **Blockade Tests**: Develop Python + Blockade tests +- **Performance Testing**: Run benchmarks with `ozone freon` and report findings + +### 4. Visual Design & Art + +Ozone welcomes contributions in design and visual arts: + +- **Logos and Icons**: Create variations of the Ozone logo for different contexts +- **Diagrams**: Design architectural and conceptual diagrams for documentation +- **Website Design**: Improve the look and feel of the Ozone website +- **Slide Decks**: Design templates for presentations about Ozone + +Share your artwork through the [GitHub Discussions](https://github.com/apache/ozone/discussions) or on the dev mailing list [email protected]. + +### 5. Bug Reports and Feature Requests + +- Report bugs or suggest features through [Jira](https://issues.apache.org/jira/projects/HDDS/) +- Search existing issues before creating a new one +- Provide detailed steps to reproduce bugs + +### 6. Community Support + +- Answer questions on [GitHub Discussions](https://github.com/apache/ozone/discussions) +- Help review pull requests +- Join community calls and discussions + +## When to Use GitHub Discussions + +The [GitHub Discussions](https://github.com/apache/ozone/discussions) platform is ideal for: + +- **Q&A**: Technical questions about using Ozone +- **Ideas**: Suggesting new features or improvements before creating a Jira issue +- **Show and Tell**: Sharing your projects built with Ozone +- **Community Engagement**: General discussions about the project direction + +For bug reports and concrete feature requests, please continue to use Jira. For code contributions, follow the pull request workflow. + +## Getting Help + +If you need assistance with your contribution, you can use the following channels: + +### Join the Dev Mailing List + +The dev mailing list is the primary communication channel for Ozone development discussions: + +1. Send an email to [[email protected]](mailto:[email protected]) +2. You'll receive a confirmation email - reply to it to confirm your subscription +3. Once subscribed, you can send emails to [[email protected]](mailto:[email protected]) +4. To unsubscribe, send an email to [[email protected]](mailto:[email protected]) + +You can also view the [mailing list archives](https://lists.apache.org/[email protected]) to see past discussions. + +## When to Use GitHub Discussions + +Alternative you can also use GitHub Discussions to get help and more. + +The [GitHub Discussions](https://github.com/apache/ozone/discussions) platform is ideal for: + +- **Q&A**: Technical questions about using Ozone +- **Ideas**: Suggesting new features or improvements before creating a Jira issue +- **Show and Tell**: Sharing your projects built with Ozone +- **Community Engagement**: General discussions about the project direction + +For bug reports and concrete feature requests, please continue to use Jira. For code contributions, follow the pull request workflow. + +### Other Communication Channels + +- Join the #ozone channel on [ASF Slack](http://s.apache.org/slack-invite) +- Attend [weekly community calls](https://cwiki.apache.org/confluence/display/OZONE/Ozone+Community+Calls) + +## Recognition + +All contributions are recognized in Apache Ozone: + +- Code contributions are recorded in Git history +- Documentation improvements help the entire community +- Testing helps ensure project quality +- Bug reports guide project improvement + +Your contributions, large or small, are valued and appreciated by the Ozone community! --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
