Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 1.91 KB
Raw

Contributing Guidelines

Please create an issue before starting work on a new feature or a substantial refactor so it can be discussed first.

GitHub Workflow

  1. Fork this repository (if this is your first contribution) or sync your fork (if you've contributed before).
  2. Create a new branch within your fork.
  3. Commit your changes on that branch.
  4. Open a pull request against this repo's master branch (see below for pull request guidelines).

Pull Requests

Please try to keep pull requests simple. Overly complex code changes are difficult to properly review. A good rule of thumb is that the pull request should focus on only one of the following categories:

  • docs: documentation changes only (README, repo health files, source code comments, etc)
  • feat: implements a new feature
  • tidy: white-space changes, reformatting, repositioning, renaming, etc.
  • refactor: change that is not a new feature, bugfix, or tidy
  • chore: changes that don't involve source or doc files (ex: continuous integration files)
  • test: changes that only touch tests or test data
  • examples/{name}: changes to the examples

The title of the pull request should begin with the type of change it contains followed by a brief overview description of what this change would accomplish. For example:

doc: fix typo in readme
core: bump ci versions

By opening a pull request to this repository, you agree to allow the project owner to license your work under the Unlicense. Please only submit code where you are the original author.

Code Style

Generally speaking, this project adheres to the guidelines outlined in Effective Go and Google's Go Style Guide.