46 lines
1.9 KiB
Markdown
46 lines
1.9 KiB
Markdown
# Contributing to the Project
|
||
|
||
Thank you for your interest in contributing to this project! We strive to make the contribution process clear and welcoming.
|
||
|
||
Please take a moment to review the guidelines below.
|
||
|
||
|
||
## 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 [Apache License 2.0](LICENSE.txt).
|
||
|
||
The project itself is also licensed under the [Apache License 2.0](LICENSE.txt)).
|