33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
|
# 💡 Contributing
|
||
|
|
|
||
|
|
Thanks a lot for your interest in contributing to **FileFormats**! 🎉
|
||
|
|
|
||
|
|
## Code of Conduct
|
||
|
|
|
||
|
|
**FileFormats** adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
|
||
|
|
|
||
|
|
## Open Development
|
||
|
|
|
||
|
|
All work on **FileFormats** happens directly on this repository. Both core team members and external contributors send pull requests which go through the same review process.
|
||
|
|
|
||
|
|
## Types of contributions
|
||
|
|
|
||
|
|
- Reporting a bug.
|
||
|
|
- Suggest a new feature idea.
|
||
|
|
- Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).
|
||
|
|
- Improve structure/format/performance/refactor/tests of the code.
|
||
|
|
|
||
|
|
## Pull Requests
|
||
|
|
|
||
|
|
- **Please first discuss** the change you wish to make via [issue](https://git.theoludwig.fr/FileFormats/fileformats/issues) before making a change. It might avoid a waste of your time.
|
||
|
|
|
||
|
|
- Ensure your code respect linting.
|
||
|
|
|
||
|
|
- Make sure your **code passes the tests**.
|
||
|
|
|
||
|
|
If you're adding new features to **FileFormats**, please include tests.
|
||
|
|
|
||
|
|
## Commits
|
||
|
|
|
||
|
|
The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
|