Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

54 lines (41 loc) · 2.6 KB

Contributing Guidelines

First off, thanks for taking the time to contribute!

Please read through our Installation Instructions.

Getting Started

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the core team before making a change.

  • Make sure you have a GitHub account.
  • Submit a GitHub issue for your issue if one does not already exist.
    • A issue is not necessary for trivial changes.
  • Fork the repository on GitHub.
  • When working on an issue, create a new branch from master named for issue number or custom name. Name the branch issue/<issue-number> or issue/<custom-name>. For example issue/22 for fixing issue #22.
  • Make your changes.
  • Create a pull request to the repository.

pre-commit

pre-commit is configured for this repo, which you may optionally use to ease the steps involved in submitting your changes. First install the pre-commit package manager using the appropriate method, then run bin/install-hooks and now pre-commit will run automatically on each git commit:

$ bin/install-hooks
pre-commit installed at .git/hooks/pre-commit
pre-commit installed at .git/hooks/commit-msg

Tips and tricks for using the Git

Key branches

  • master is the latest, deployed version.

Contribute to the core code or bug fixes