mirrors/quetre
1
0
Fork 0
mirror of https://github.com/zyachel/quetre.git synced 2025-04-04 05:27:36 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Create CONTRIBUTING.md

Browse source
This commit is contained in:
NebulaOnion 2023-01-28 17:36:43 +00:00 • committed by GitHub
parent 494f85be2d
commit d74e8e9e0a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

22
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,22 @@
# Contributing to Quetre
First of all, thanks for reading this document!
## Bugs and issues
If you happen to come across and issue or bug in Quetre, You can create a new issue by clicking [here](https://github.com/zyachel/quetre/issues/new/choose). (You can also go to the GitHub issues tab).
**Issues can be feature requests too!**
Here are some nice tips for helpful issues:
- Use a good title
Issue titles are important since we use them to organize the issue board, therefore, please choose titles that are short and describe the issue in detail.
- Include every detail you can think of
This means logs, tracebacks, use cases (if the issue is about a feature)...
## Pull requests and commits
If you wish to contribute code, you can do so by forking the repository, doing the changes and then opening a pull request for your changes to be reviewed.
We just please ask you to write commit messages using the [Conventional Commits standard](https://www.conventionalcommits.org/en), there is a tool called [Commitizen](https://commitizen.github.io/cz-cli/) *(or CZ)* that automatically formats and names your commit using this standard, in case you are interested.