docs: add LICENSE

This commit is contained in:
Maël Gangloff
2024-07-11 00:05:24 +02:00
parent 045c4d17b4
commit 52471c3f77
4 changed files with 834 additions and 0 deletions

29
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,29 @@
# Contributing
Welcome to our project! We're excited to have you contribute. Before you get started, please take a moment to review the guidelines below.
How to Contribute
1. Fork the repository to your own GitHub account.
2. Clone the forked repository to your local machine.
3. Create a new branch for your contribution: `git checkout -b feature/new-feature`.
4. Make your changes and commit them with a descriptive commit message following the [Conventional Commits](https://www.conventionalcommits.org) standard.
5. Sign your commits using a GPG key (if possible).
6. Push your changes to your forked repository: `git push origin feature/new-feature`.
7. Open a pull request against the `master` branch of the original repository.
8. Await review and feedback from the maintainers.
## Code Style
Please follow the existing code style and conventions used in the project. If you're introducing new functionality, ensure that your code is well-documented and follows best practices.
## Reporting Issues
If you encounter any issues with the project, please open an issue on the GitHub repository. Include as much detail as possible, including steps to reproduce the issue.
## Feature Requests
Have a feature you'd like to see added to the project? Feel free to open an issue on GitHub and describe the feature you're envisioning. We'll review it and discuss its feasibility.
## Communication
Feel free to reach out to the maintainers if you have any questions or need assistance. You can contact us via GitHub issues or email.
Thank you for your interest in contributing to this project! Your contributions help make the project better for everyone.