Skip to content

Latest commit

 

History

History
239 lines (152 loc) · 9.93 KB

CONTRIBUTING.md

File metadata and controls

239 lines (152 loc) · 9.93 KB
Raw

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(Open-Set-Go server)

Submitting an Issue

Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.

We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario using a repository. Having a live, reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like:

  • environments where the Open-Set-Go server is running (OS, Browser...)
  • a use-case that fails

You can file new issues by filling out our new issue form.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub Pull Requests for an open or closed PR that relates to your submission. You don't want to duplicate effort.

  2. Fork this repository to your GitHub click to fork Open-Set-Go_server!

  3. Clone your Open-Set-Go_server repository :

    git clone --recursive your-github-id/Open-Set-Go_server

  4. Make your changes in a main branch(or feature branch):

  5. Follow our style guide.
    This is simply a recommendation, so please feel free to contribute!

  6. Run the eslint & prettier at root to pass our CI workflows

    yarn CI

  7. Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.

    git commit -a -s
# -s is an option to sign-off your code, and we recommend to use it!

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  8. Push your branch to GitHub:

    git push

  9. In GitHub, send a pull request to Open-Set-Go:main or Open-Set-Go:feature/* .


That's it! Thank you for your contribution! ✨


Development Setting

Development Environment

Supported Environment Version Description
Ubuntu OS Ubuntu 22.04 LTS
Windows OS Windows 11
Node.js >= 18.x ocotokit/rest require >= node v18.x
@nestjs/cli 9.5.0
yarn 1.22.19

  1. Clone our repository with recursive options!

    git clone AgainIoT/Open-Set-Go_server --recursive

  2. After cloning the repo, and run yarn to install dependencies!

    yarn install

Commonly used Yarn Scripts

# run build
$ yarn run build

# run linter & prettier
$ yarn CI

# run code by development environment(+ nodemon)
$ yarn start:dev

# run code by deploy environment
$ yarn deploy



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. Don't be afraid We love English, too

이 프로젝트를 시작한 maintainer들은 한국의 국민대학교 학부생들입니다. 그렇기 때문에 우리는 영어와 한국어를 같이 사용하고 있습니다. 물론, 프로젝트는 영어를 기반으로 하고 있지만, 영어와 한국어를 사용하는 기여를 모두 환영하고 있습니다. 겁내지 말아요. 저희는 한국어를 사랑합니다.

For more information, see CODE_OF_CONDUCT.md.

Style Guide

GitLab-flow

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

For Contributors

For Collaborators

Commit Message Style

Type Content
Init Development Environment Initial Setting
Feat Add New Features
Fix Fix Bugs
Update Unlike Fix, it originally operated normally, but the concept of complement
Remove When deleting a file
Move When moving a code or file
Rename To modify a file or folder name
Docs If the document is modified
Comment Add and change required annotations
Refactor Code refactoring (reorganizing code without changing results, increasing readability)
Test Test code
Chore Other minor modifications 
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

※ Anyone who wants to be a collaborator of Open-Set-Go is always welcome!