...

Text file src/github.com/go-chi/chi/CONTRIBUTING.md

Documentation: github.com/go-chi/chi

     1# Contributing
     2
     3## Prerequisites
     4
     51. [Install Go][go-install].
     62. Download the sources and switch the working directory:
     7
     8    ```bash
     9    go get -u -d github.com/go-chi/chi
    10    cd $GOPATH/src/github.com/go-chi/chi
    11    ```
    12
    13## Submitting a Pull Request
    14
    15A typical workflow is:
    16
    171. [Fork the repository.][fork] [This tip maybe also helpful.][go-fork-tip]
    182. [Create a topic branch.][branch]
    193. Add tests for your change.
    204. Run `go test`. If your tests pass, return to the step 3.
    215. Implement the change and ensure the steps from the previous step pass.
    226. Run `goimports -w .`, to ensure the new code conforms to Go formatting guideline.
    237. [Add, commit and push your changes.][git-help]
    248. [Submit a pull request.][pull-req]
    25
    26[go-install]: https://golang.org/doc/install
    27[go-fork-tip]: http://blog.campoy.cat/2014/03/github-and-go-forking-pull-requests-and.html
    28[fork]: https://help.github.com/articles/fork-a-repo
    29[branch]: http://learn.github.com/p/branching.html
    30[git-help]: https://guides.github.com
    31[pull-req]: https://help.github.com/articles/using-pull-requests

View as plain text