Skip to content

Commit

Permalink
docs: update contributing guidelines
Browse files Browse the repository at this point in the history
Signed-off-by: sebthom <sebthom@users.noreply.github.com>
  • Loading branch information
sebthom committed Aug 26, 2024
1 parent 3dde352 commit 1ee3d4f
Showing 1 changed file with 42 additions and 4 deletions.
46 changes: 42 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,45 @@
Project licensed under the [Eclipse Public License 1.0 (EPL)](LICENSE).
# Contributing to the Project

* You will only Submit Contributions where You have authored 100% of the content.
Thank you for your interest in contributing to this project! We strive to make the contribution process clear and welcoming.

* You will only Submit Contributions to which You have the necessary rights. This means that if You are employed, You have received the necessary permissions from Your employer to make the Contributions.
Please take a moment to review the guidelines below.

* Whatever content You Contribute will be provided under the Project License.

## Code of Conduct

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


## How to Contribute

### Contributor Responsibilities

By submitting your contributions, you agree to the following:
- You are the sole author of the content you contribute, or you have the appropriate rights and permissions to contribute it.
- If employed, you have obtained any necessary permissions from your employer to contribute to this project.
- All contributions will be made available under the project’s license.

### 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](#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.


## Licensing

By contributing to this project, you agree that your contributions will be licensed under the [Eclipse Public License 2.0](LICENSE.txt).

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

0 comments on commit 1ee3d4f

Please sign in to comment.