1
1
mirror of https://github.com/theoludwig/libcproject.git synced 2024-09-19 21:35:53 +02:00
libcproject/CONTRIBUTING.md

33 lines
1.3 KiB
Markdown
Raw Normal View History

2023-01-05 21:13:10 +01:00
# 💡 Contributing
Thanks a lot for your interest in contributing to **libcproject**! 🎉
2023-06-25 21:32:16 +02:00
## Code of Conduct
**libcproject** 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 **libcproject** happens directly on this repository. Both core team members and external contributors send pull requests which go through the same review process.
2023-01-05 21:13:10 +01:00
## 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
2023-06-24 20:29:30 +02:00
- **Please first discuss** the change you wish to make via [issue](https://github.com/theoludwig/libcproject/issues) before making a change. It might avoid a waste of your time.
2023-01-05 21:13:10 +01:00
- Ensure your code respect linting.
- Make sure your **code passes the tests**.
If you're adding new features to **libcproject**, please include tests.
## Commits
2023-06-25 21:32:16 +02:00
The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.