Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

72 lines (50 loc) · 3.13 KB
Raw

Contributing to Java Evolution

First off, thank you for considering contributing to Java Evolution! It's people like you that make the open-source community such a fantastic place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Code of Conduct

This project and everyone participating in it are governed by the Java Evolution Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]].

I don't want to read this whole thing I just have a question!!!

If you have questions about how to contribute, please send an email to [[email protected]], and we'll do our best to respond promptly.

What we are looking for

We are looking for contributions that enhance the documentation and examples of Java features from version 8 to 21. This includes but is not limited to:

  • Detailed explanations of specific features
  • Code examples demonstrating the use of new features
  • Corrections of inaccuracies or errors in the documentation
  • Updates for new Java versions as they are released

Getting started

Contributions to this project can be made in several ways:

  1. Submit bugs and feature requests, and help us verify as they are checked in
  2. Review source code changes
  3. Contribute updates and improvements to the documentation

How to contribute

If you are ready to contribute to Java Evolution, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine.
  3. Create a new branch for your changes.
  4. Make your changes and commit them to your branch. Be sure to write a clear commit message that explains the rationale and context of your changes.
  5. Push your changes to your fork on GitHub.
  6. Submit a pull request to the main Java Evolution repository. Link any relevant issues or previous discussions and describe your changes in detail.

Pull Request Guidelines

  • Ensure that each pull request focuses on a single feature or bug fix. If you have multiple changes to propose, submit them as separate pull requests.
  • Write a clear, descriptive title and a detailed pull request description.
  • Include examples of how to use the new feature or bug fix if applicable.
  • Update the relevant documentation or README files to reflect your changes.
  • Keep your pull requests as small and focused as possible. This facilitates quicker review and merging.

Code review process

The project maintainers will review all pull requests. We aim to review and comment on pull requests within 3 business days. During the review process, we may request further changes or clarification. Once approval is given, we will merge your changes.

Community

Staying connected and getting involved with the community is a great way to stay informed, get help, and contribute to the project:

  • Join discussions: Participate in discussions on GitHub issues or pull requests.
  • Share your work: If you're using Java Evolution in a project, write a blog post or tweet about it. Share your experiences and learnings with the community.

Thank you for contributing to Java Evolution!