generated from cloudwego/.github
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
opt: use
SIMD-match-pair
algorithm to boost JSON skip
- Loading branch information
Showing
17 changed files
with
1,779 additions
and
563 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# How to Contribute | ||
|
||
## Your First Pull Request | ||
We use github for our codebase. You can start by reading [How To Pull Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). | ||
|
||
## Branch Organization | ||
We use [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) as our branch organization, as known as [FDD](https://en.wikipedia.org/wiki/Feature-driven_development) | ||
|
||
## Bugs | ||
### 1. How to Find Known Issues | ||
We are using [Github Issues](https://github.com/cloudwego/dynamicgo/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. | ||
|
||
### 2. Reporting New Issues | ||
Providing a reduced test code is a recommended way for reporting issues. Then can placed in: | ||
- Just in issues | ||
- [Golang Playground](https://play.golang.org/) | ||
|
||
### 3. Security Bugs | ||
Please do not report the safe disclosure of bugs to public issues. Contact us by [Support Email](mailto:[email protected]) | ||
|
||
## How to Get in Touch | ||
- [Email](mailto:[email protected]) | ||
|
||
## Submit a Pull Request | ||
Before you submit your Pull Request (PR) consider the following guidelines: | ||
1. Search [GitHub](https://github.com/cloudwego/dynamicgo/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts. | ||
2. Please submit an issue instead of PR if you have a better suggestion for format tools. We won't accept a lot of file changes directly without issue statement and assignment. | ||
3. Be sure that the issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Before we accepting your work, we need to conduct some checks and evaluations. So, It will be better if you can discuss the design with us. | ||
4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the cloudwego/dynamicgo repo. | ||
5. In your forked repository, make your changes in a new git branch: | ||
``` | ||
git checkout -b my-fix-branch develop | ||
``` | ||
6. Create your patch, including appropriate test cases. | ||
7. Follow our [Style Guides](#code-style-guides). | ||
8. Commit your changes using a descriptive commit message that follows [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit). | ||
Adherence to these conventions is necessary because release notes are automatically generated from these messages. | ||
9. Push your branch to GitHub: | ||
``` | ||
git push origin my-fix-branch | ||
``` | ||
10. In GitHub, send a pull request to `dynamicgo:main` with a clear and unambiguous title. | ||
## Contribution Prerequisites | ||
- Our development environment keeps up with [Go Official](https://golang.org/project/). | ||
- You need fully checking with lint tools before submit your pull request. [gofmt](https://golang.org/pkg/cmd/gofmt/) and [golangci-lint](https://github.com/golangci/golangci-lint) | ||
- You are familiar with [Github](https://github.com) | ||
- Maybe you need familiar with [Actions](https://github.com/features/actions)(our default workflow tool). | ||
## Code Style Guides | ||
See [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments). | ||
Good resources: | ||
- [Effective Go](https://golang.org/doc/effective_go) | ||
- [Pingcap General advice](https://pingcap.github.io/style-guide/general.html) | ||
- [Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.