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

docs: add CONTRIBUTING.md

Browse source
This commit is contained in:
NebulaOnion 2023-01-28 18:09:46 +00:00
parent 494f85be2d
commit 5542715713
No known key found for this signature in database
GPG key ID: B23A333C69C01FA4
2 changed files with 30 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,26 @@
# 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.
About the license, by contributing to Quetre, **you agree for all your contributions to be placed under the AGPL-v3.0 license.** You can view a copy [here](https://www.gnu.org/licenses/agpl-3.0.html).

6
README.md
View file

@ -41,7 +41,7 @@ It enables you to see answers without ads, trackers, and other such bloat.
- Unofficial API support
just add `/api/v1/` after the domain name in the URL and get a JSON response.
just add `/api/v1/` after the domain name in the URL and get a JSON response.
---
@ -239,6 +239,8 @@ The development may seem slow as I don't have lots of free time. And whenever I
If you believe you can help furthering this project in any way(be it maintaining, fixing issues, or adding features), please [get in touch](#contact).
Regardless, any type of contribution is always welcome.
**If you plan on contributing, please read our [CONTRIBUTING.md](./CONTRIBUTING.md) file.**
## Misc
### Automatic redirection
@ -320,4 +322,4 @@ Send a message on [\[matrix\]](https://matrix.to/#/@ninal:matrix.org) or go old
## License
Licensed under [GNU AGPLv3](./LICENSE).
Licensed under [GNU AGPLv3](./LICENSE).