We welcome contributions to this project! Below are guidelines to help you get started.
-
Fork the repository:
Create your own fork of the repository by clicking the "Fork" button in GitHub. -
Create a feature branch:
Clone your fork locally, then create a feature branch for your work:git checkout -b feature/my-new-feature
-
Make your changes:
Implement your changes, ensuring that they follow the project’s coding standards and best practices. -
Commit your changes:
Commit your changes to your feature branch:git commit -am 'Add some feature'
-
Push your changes to your fork:
Push your changes to your fork on GitHub:git push origin feature/my-new-feature
-
Create a Pull Request: Once your changes are ready, open a pull request (PR) from your branch on GitHub.
- Ensure that your PR description explains what changes you’ve made and why.
- Mention any related issues, if applicable.
Before submitting a PR, make sure all tests pass:
./mvnw test
If you’ve added new features, consider adding appropriate unit tests as well.
Please note that this project is governed by a Code of Conduct. By participating, you are expected to uphold this code.