Skip to content

Latest commit

 

History

History
48 lines (26 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

48 lines (26 loc) · 1.86 KB
Raw

Contributing to the Project

Thank you for your interest in contributing to this project!

We want to make contributing as easy and transparent as possible.

Please take a moment to review the guidelines below.

Code of Conduct

Please review and adhere to our Code of Conduct in all your interactions with the project. This helps us maintain a positive and respectful environment for everyone involved.

How to Contribute

Issues

We use GitHub Issues to track bugs and feature requests. When submitting an issue, please ensure:

  • The description is clear and concise.
  • You provide enough details and steps to reproduce the issue, if applicable.

Pull Requests

Before making substantial contributions:

  1. Discuss Changes: Please file an issue first to discuss your proposed changes with the team. This helps ensure your contribution aligns with the project’s goals.
  2. Follow Best Practices: Adhere to the guidelines and ensure your code meets the project’s standards (see Code Guidelines).

When submitting a pull request:

  • Ensure your changes are well-documented.
  • Include tests for any new features or significant changes.
  • Reference the relevant issue(s) in your pull request description.

Source Code Formatting

Before committing your code ensure it is formatted according the vegardit.com Eclipse formatter rules.

IntelliJ users can use the Eclipse Code Formatter plugin to import and use the formatter settings.

Licensing

By contributing to this project, you agree that your contributions will be licensed under the Eclipse Public License 2.0.

The project itself is also licensed under the Eclipse Public License 2.0 (EPL).