tikv
/
client-go
mirror of https://github.com/tikv/client-go.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add contributing (#94) 

Signed-off-by: disksing <i@disksing.com>
This commit is contained in:
disksing 2021-06-19 04:01:45 +08:00 committed by GitHub
parent 8c6eba4589
commit c733293d06
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 40 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,34 @@
# Contributing to client-go
We LOVE your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Submitting a fix
- Proposing a new feature
- Discussing the current state of the code
- Becoming a maintainer
## Submitting Pull Request
Pull Requests are the best way to propose changes to codebase. We actively welcome your Pull Requests.
If you are contributing to an open source project for the first time, please read the [detailed how-to guide](https://github.com/firstcontributions/first-contributions).
It is important to note that we enforces the [Developer Certificate of Origin](https://developercertificate.org/) (DCO) on Pull Requests. Please read [more about how it works](https://github.com/apps/dco).
## Reporting issues
We use GitHub to track public bugs and issues. Report an issue by [opening a new issue](https://github.com/tikv/client-go/issues/new).
**Great Bug Reports** tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
If you tend to use Chinese to propose issues, [asktug](https://asktug.com/) is also a good choice.

8
README.md
View File

@ -29,12 +29,16 @@ To run tests, run the following command
go test ./...
```
## Contributing to client-go
Pull Requests and issues are welcomed. Please check [CONTRIBUTING.md](./CONTRIBUTING.md).
## Used By
This project is used by the following projects:
- TiDB (https://github.com/pingcap/tidb)
- TiDB: TiDB is an open source distributed HTAP database compatible with the MySQL protocol (https://github.com/pingcap/tidb)
- BR: A command-line tool for distributed backup and restoration of the TiDB cluster data (https://github.com/pingcap/br)
## License