mirror of
https://github.com/theoludwig/libcproject.git
synced 2025-05-21 23:21:15 +02:00
48 lines
1.5 KiB
Markdown
48 lines
1.5 KiB
Markdown
# 💡 Contributing
|
|
|
|
Thanks a lot for your interest in contributing to **libcproject**! 🎉
|
|
|
|
## 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.
|
|
|
|
## 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://github.com/theoludwig/libcproject/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 **libcproject**, please include tests.
|
|
|
|
## Commits
|
|
|
|
The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
|
|
|
|
## Git Submodules
|
|
|
|
To get the submodule:
|
|
|
|
```sh
|
|
git submodule update --init --recursive
|
|
```
|
|
|
|
To update the version:
|
|
|
|
```sh
|
|
cd doxygen-awesome-css
|
|
git checkout v2.3.3
|
|
```
|