Skip to content

Latest commit

聽

History

History
94 lines (68 loc) 路 3.69 KB

CONTRIBUTING.md

File metadata and controls

94 lines (68 loc) 路 3.69 KB
Raw

Contribution Guidelines

This Contribution Guidelines is modified from the GitHub doc project

Feel free to ask any questions in the Discussions QA

Issues

Create a new issue

If you have the following ideas

  • spot a problem with the project 馃悰
  • have any suggestions 馃搱
  • want a new style 馃拕

search if an issue already exists.
If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix.

Make changes

  1. Fork and Clone the Repository
git clone git@github.com:yourname/g.git
  1. Make sure you have installed go, and go version >= 1.22.0 .
go version
  1. Make your changes!

Commit messages

It's recommended to follow the commit style below:

<type>[optional scope]: <description>

[optional body]

fix:
feat:
build:
chore:
ci:
docs:
style:
refactor:
perf:
test:
...

Also, you can use gitmoji in the commit message

Examples are provided to illustrate the recommended style:

style: :lipstick: change color for 'readme' file
    
change from BrightYellow to Yellow

Tests

Please refer to the TestWorkflow

PR

When you're finished with the changes, create a pull request, also known as a PR.
Before you submit your pr, please check out the following stuffs

  • you have run go mod tidy and gofumpt -w -l .
  • your code has the necessary comments and documentation (if needed)
  • you have written tests for your changes (if needed)
  • Pass other tests, if you're breaking the tests, please explain why in the PR description

and when you're submitting your pr, make sure to:

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, maintainers will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Release

Please refer to the ReleaseWorkflow