github.com/KinWaiYuen/client-go/v2@v2.5.4/CONTRIBUTING.md (about)

     1  # Contributing to client-go
     2  
     3  We LOVE your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
     4  
     5  - Reporting a bug
     6  - Submitting a fix
     7  - Proposing a new feature
     8  - Discussing the current state of the code
     9  - Becoming a maintainer
    10  
    11  ## Submitting Pull Request
    12  
    13  Pull Requests are the best way to propose changes to codebase. We actively welcome your Pull Requests.
    14  
    15  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).
    16  
    17  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).
    18  
    19  ## Reporting issues
    20  
    21  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).
    22  
    23  **Great Bug Reports** tend to have:
    24  
    25  - A quick summary and/or background
    26  - Steps to reproduce
    27    - Be specific!
    28    - Give sample code if you can
    29  - What you expected would happen
    30  - What actually happens
    31  - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
    32  
    33  If you tend to use Chinese to propose issues, [asktug](https://asktug.com/) is also a good choice.
    34