Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (30 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.52 KB

Contributing to This Project

Thank you for considering contributing to this project! 🎉
This guide will help you get started and ensure your contributions are productive and welcome.

📌 What You Can Contribute

  • Bug reports
  • Bug fixes
  • New features or improvements
  • Documentation updates
  • Tests or improvements to test coverage
  • Discussions and feedback on issues or pull requests

🧑‍💻 How to Contribute

  1. Fork the Repository
    Create a fork of this repository using the GitHub UI.

  2. Create a Branch
    Use a descriptive branch name, e.g., fix/abc or feature/provide-cassandra-support.

  3. Make Your Changes
    Keep commits clear and descriptive. Use Conventional Commits.

  4. Run Tests (if applicable)
    Make sure your changes don't break existing tests.

    Run ./mvnw install or, in case you have act installed, act --action-offline-mode --artifact-server-path $PWD/.artifacts pull_request which will run the Github-Action pipeline locally.

  5. Push & Create Pull Request
    Push your branch and open a Pull Request against the main branch, depending on the project's workflow.

    In your PR description, please include:

    • WHAT was changed
    • WHY it was changed
    • HOW it can be tested (if relevant)

🤝 Support & Contact

If you need help or have questions, feel free to open an issue.

Thank you for helping improve this project! 🙌