Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

81 lines (60 loc) · 2.42 KB
Raw

Table of Contents generated with DocToc

Contributing

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.

Setup

Fork, then clone the repository:

git clone github.com/rookie-ninja/rk-docs.git
cd rk-entry
git remote add upstream github.com/rookie-ninja/rk-docs.git
git fetch upstream

Install rk-entry's dependencies:

go mod tidy

Make sure that the tests and the linters pass:

make test
make lint

If you're not using the minor version of Go specified in the Makefile's LINTABLE_MINOR_VERSIONS variable, make lint doesn't do anything. This is fine, but it means that you'll only discover lint failures after you open your pull request.

Making Changes

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][commit-message].
  • Maintain backward compatibility.