Skip to content

📝 Add contributing documentation #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Whisper40 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

📝 Add contributing documentation #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

@evrardjp evrardjp Nov 21, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"If you find an issue to work on, you are welcome to open a PR with a fix."

You can remove the first sentence, and on top of it, there is a typo on the " ' " sign. (Incorrect character)


### 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.

@evrardjp evrardjp Nov 21, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should explain how to test changes?


### 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.