Table of Contents generated with DocToc
We'd love your help make rk-mux the very best structured Mux bootstrapper library in Go!
If you'd like to add new features, please open an issue describing your proposal problem; discussing feature changes ahead of time makes pull request review much smoother. In your issue, pull request, and any other communications, please remember to treat your fellow contributors with respect! We take our code of conduct seriously.
Fork, then clone the repository:
git clone https://github.com/rookie-ninja/rk-mux.git
cd rk-mux
git remote add upstream https://github.com/rookie-ninja/rk-mux.git
git fetch upstream
Install rk-mux's dependencies:
go mod tidy
Start by creating a new branch for your changes:
git checkout master
git fetch upstream
git rebase upstream/master
git checkout -b cool_new_feature
Make your changes, then ensure that make lint and make test still pass. If
you're satisfied with your changes, push them to your fork.
git push origin cool_new_feature
Then use the GitHub UI to open a pull request.
At this point, you're waiting on us to review your changes. We try to respond to issues and pull requests within a few business days, and we may suggest some improvements or alternatives. Once your changes are approved, one of the project maintainers will merge them.
We're much more likely to approve your changes if you:
- Add tests for new functionality.
- Write a good commit message.
- Maintain backward compatibility.