github.com/bufbuild/connect-grpchealth-go@v1.1.1/.github/CONTRIBUTING.md (about)

     1  Contributing
     2  ============
     3  
     4  We'd love your help making `connect-grpchealth-go` better!
     5  
     6  If you'd like to add new exported APIs, please [open an issue][open-issue]
     7  describing your proposal — discussing API changes ahead of time makes
     8  pull request review much smoother. In your issue, pull request, and any other
     9  communications, please remember to treat your fellow contributors with
    10  respect!
    11  
    12  Note that you'll need to sign [Buf's Contributor License Agreement][cla]
    13  before we can accept any of your contributions. If necessary, a bot will remind
    14  you to accept the CLA when you open your pull request.
    15  
    16  ## Setup
    17  
    18  [Fork][fork], then clone the repository:
    19  
    20  ```
    21  mkdir -p $GOPATH/src/github.com/bufbuild
    22  cd $GOPATH/src/github.com/bufbuild
    23  git clone git@github.com:your_github_username/connect-grpchealth-go.git
    24  cd connect-grpchealth-go
    25  git remote add upstream https://github.com/bufbuild/connect-grpchealth-go.git
    26  git fetch upstream
    27  ```
    28  
    29  Make sure that the tests and the linters pass (you'll need `bash`, `curl`, and
    30  the latest stable Go release installed):
    31  
    32  ```
    33  make 
    34  ```
    35  
    36  ## Making Changes
    37  
    38  Start by creating a new branch for your changes:
    39  
    40  ```
    41  cd $GOPATH/src/github.com/bufbuild/connect-grpchealth-go
    42  git checkout main
    43  git fetch upstream
    44  git rebase upstream/main
    45  git checkout -b cool_new_feature
    46  ```
    47  
    48  Make your changes, then ensure that `make` still passes. (If you'd prefer, you
    49  can use the standard `go build ./...` and `go test ./...` while you're coding.)
    50  When you're satisfied with your changes, push them to your fork.
    51  
    52  ```
    53  git commit -a
    54  git push origin cool_new_feature
    55  ```
    56  
    57  Then use the GitHub UI to open a pull request.
    58  
    59  At this point, you're waiting on us to review your changes. We *try* to respond
    60  to issues and pull requests within a few business days, and we may suggest some
    61  improvements or alternatives. Once your changes are approved, one of the
    62  project maintainers will merge them.
    63  
    64  We're much more likely to approve your changes if you:
    65  
    66  * Add tests for new functionality.
    67  * Write a [good commit message][commit-message].
    68  * Maintain backward compatibility.
    69  
    70  [fork]: https://github.com/bufbuild/connect-grpchealth-go/fork
    71  [open-issue]: https://github.com/bufbuild/connect-grpchealth-go/issues/new
    72  [cla]: https://cla-assistant.io/bufbuild/connect-grpchealth-go
    73  [commit-message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html