Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) · 1.38 KB

Contributing

Thank you for considering contributing to this project! Here are some guidelines to help you get started.

Reporting Issues

If you find a bug, have an idea for an enhancement, or want to start a discussion, please file an issue in the repository. Make sure to provide as much detail as possible to help us understand and address the issue. A reproduction of the issue, including steps to reproduce, is always helpful.

Branch Naming

When working on an issue, create a new branch starting with issue-xx where xx is the number of the issue. For example, if you are working on issue #42, your branch should be named issue-42-the-issue-to-be-fixed.

Submitting a Pull Request

  1. Run mvn verify to ensure your changes pass all tests and styling.
  2. Commit your changes to your branch on your fork. How to create a fork
  3. Push your branch to your forked repository.
  4. Submit a pull request (PR) from your forked repository to the main repository.
  5. Reference the issue number in your PR description.

Code Style

Please ensure your code adheres to the project's coding standards and passes all tests. This helps maintain code quality and consistency.

Thank You

We appreciate your contributions and efforts to improve this project. Thank you for your support!