Contributing

You can also check this out on CONTRIBUTING.md on our GitHub. Shortcut of CONTRIBUTING.md

Welcome to Open-Set-Go contributing guide #

Thank you for investing your time in contributing to our Open-Set-Go project! Any contribution you make will be reflected on Open-Set-Go.io & README.md ✨.

We are committed to fostering a contribution-friendly environment that encourages contributions and aims to evolve into an open-source community. Please have a lot of conversations on our Discussion!

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Ways to contribute #

Contributors #

There are several ways you can contribute to Open-Set-Go!

• Troubleshoot problems that existed code.
• Submit Bug/Feature issues related to bugs or desired new features.
• Submit Documentation issues for insufficient documents, translations.
• Start conversation at Discussions to provide a good example of preset.
• Start conversation by posting to Discussions about a framework that needs support.
• If there’s anything you’d like to communicate about our project or open source, feel free to post it on Discussions! “We hope that Open-Set-Go Discussions will become an active community.”

Collaborators #

If you want to contribute directly to our project, be our collaborators at Open-Set-Go! Join the Slack to become a collaborator!

• Develop Main Features:
  Collaborator will develop the main features with maintainers based on milestone All contributions are equally valuable and valuable to Open-Set-Go projects.and issues.

• Communication:
  Communicate with Open-Set-Go maintainers with Slack to carry out the project.

All contributions are equally valuable and valuable to Open-Set-Go projects.

Got a Question or Problem? #

If you have any question or problem, start conversation at Discussions! Then our maintainers, collaborators and contributers will help you.

Submitting a issue! #

Do your best to follow these guidelines when submitting bug-related issues or feature requests. Then we will be able to respond quickly with good feedback more easily.

Did you find a bug? #

If you find a bug in the source code, you can help us by submitting an Bug Report issue. Even better, you can submit a Pull Request with a fix.

Do you want a new feature? #

You can request a new feature by submitting an Feature Request issue. If you have a framework that needs support, please post it on Framework Request Issue!

Do you want to add documentation(translation)? #

We’re always looking for improvements to the documentation that make it more clear and accurate. Please let us know how the documentation can be improved such as typos and any content that is missing, unclear or inaccurate. We’ll be happy to make the changes or help you make a contribution if you’re interested!

You can add documentation by create a Pull Request!

Submission Guidelines #

You can view Submission Guidelines for each Server/Client from the link below.

• Client Development Settings
• Server Development Settings
  
  

Development Setting #

You can view Development Settings for each Server/Client from the link below.

• Client Development Settings
• Server Development Settings
  
  

Code of Conduct #

The maintainers who started the project are undergraduates of Kookmin University in South Korea. That’s why we use English and Korean alternately. Of course, the project is based on English, but we welcome the contributions of both English and Korean.

For more information, see CODE_OF_CONDUCT.md.

Style Guide #

GitLab-flow #

We are developing using GitLab-flow. See GitLab-flow for more information.

Commit Message Style #

git config --local commit.template .gitmessage.txt

You can apply .gitmessage.txt in the same way as above!

Commit message format #

<Type> : <Title> #<Issue Number>

<Content>

Samples #

Feat : New feature added! #24

- something added 1
- another else added 2