From 84f3c2354e1a0630be2da01dd7ef8f67097c643e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20PEREZ?= Date: Fri, 3 Nov 2023 10:23:43 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20contributing=20documentati?= =?UTF-8?q?on=20---=20Informe=20que=20le=20contributeur=20peut=20cr=C3=A9e?= =?UTF-8?q?r=20une=20issue=20et=20link=C3=A9e=20une=20PR=20apportant=20le?= =?UTF-8?q?=20correctif/fonctionnalit=C3=A9.=20Permet=20de=20savoir=20comm?= =?UTF-8?q?ent=20cr=C3=A9er=20une=20nouvelle=20version=20de=20l'outil.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1151c95 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Welcome to Kotary docs contributing guide + +Thank you for investing your time in contributing to our project! + +In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. + + +## New contributor guide + +To get an overview of the project, read the [README](README.md) file. Here are some resources to help you get started with open source contributions: + +### Issues + +#### Create a new issue + +If you spot a problem with the docs or if a related issue doesn't exist, you can open a new issue. + +#### Solve an issue + +Scan through our existing issues to find one that interests you. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix. + +### Make Changes + +If you'd like to add a feature or make a fix, please submit a PR explaining how your MR meets the need. + +### Publish Release + +To publish a new version of the tool, modify the version in the VERSION.TXT file and create a new release of the tool by creating a tag attached to this release and bearing the version to be created. \ No newline at end of file