Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

57 lines (37 loc) · 2.45 KB

How to contribute

First of all, thank you for considering contributing to this project! We appreciate your time and effort to make this project better. To ensure a smooth collaboration, please follow these guidelines:

Create an Issue

Before starting any work, create an issue to discuss your idea or problem. This allows maintainers and the community to provide feedback and avoid duplicated efforts.

Issue Guidelines

  • Provide a clear and concise title for the issue.
  • Include a detailed description of the problem or feature request.
  • Suggest a potential solution or approach to resolve the issue.
  • If applicable, include relevant code snippets, screenshots, or references to help us understand the issue better.

Once your issue is reviewed and approved, you can proceed to submit a pull request.

Submitting a Pull Request

After your issue is approved, follow these steps to submit a pull request:

Pull Request Guidelines

  1. Fork the repository and create a branch for your changes.
  2. Address the issue described and follow the coding standards of the project.
  3. Write or update tests to ensure your changes are properly covered. For Java code add a test in the core module and for the UI add a test in the ui.tests module.
  4. Ensure all quality gates pass (e.g., linter, formatter, build, tests, etc.).
  5. Update the CHANGELOG.md with a brief description of your changes:
    • Include the issue number and a summary of your contribution.

Quality Gates

Your pull request must meet the following requirements:

  • Code builds successfully and passes all automated checks.
  • Unit tests are added or updated for your changes.
  • Existing tests pass without any errors.
  • Documentation is updated if applicable.

Once your pull request is ready:

  • Link the PR to the issue it resolves.
  • Add a clear description of your changes and why they are necessary.

Review and Approval

After submitting your pull request:

  • A maintainer will review your changes and may request updates or improvements.
  • Please respond to feedback promptly and make requested changes.
  • Once your pull request meets all requirements, it will be merged into the main branch.

Need Help?

If you have questions or need help at any stage of the contribution process feel free to comment on your issue or pull request for clarification. Thank you for contributing! Your efforts make this project better for everyone.