We use GitHub for our codebase. You can start by reading How To Pull Request.
We use git-flow as our branch organization, as known as FDD
We are using GitHub Issues for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist.
Providing a reduced test code is a recommended way for reporting issues. Then can placed in:
- Just in issues
- Golang Playground
Please do not report the safe disclosure of bugs to public issues. Contact us by Support Email
Before you submit your Pull Request (PR) consider the following guidelines:
- Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.
- Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the de#front helps to ensure that we're ready to accept your work.
- Fork the cloudwego/goref repo.
- In your forked repository, make your changes in a new git branch:
git checkout -b my-fix-branch main - Create your patch, including appropriate test cases.
- Follow our Style Guides.
- Commit your changes using a descriptive commit message that follows AngularJS Git Commit Message Conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.
- Push your branch to GitHub:
git push origin my-fix-branch - In GitHub, send a pull request to
goref:main
- Our development environment keeps up with Go Official.
- You need fully checking with lint tools before submit your pull request. gofmt and golangci-lint
- You are familiar with Github
- Maybe you need familiar with Actions(our default workflow tool).