peridot/vendor/github.com/go-chi/chi/CONTRIBUTING.md
2022-07-07 22:13:21 +02:00

1 KiB

Contributing

Prerequisites

  1. Install Go.

  2. Download the sources and switch the working directory:

    go get -u -d github.com/go-chi/chi
    cd $GOPATH/src/github.com/go-chi/chi
    

Submitting a Pull Request

A typical workflow is:

  1. Fork the repository. This tip maybe also helpful.
  2. Create a topic branch.
  3. Add tests for your change.
  4. Run go test. If your tests pass, return to the step 3.
  5. Implement the change and ensure the steps from the previous step pass.
  6. Run goimports -w ., to ensure the new code conforms to Go formatting guideline.
  7. Add, commit and push your changes.
  8. Submit a pull request.