Skip to content

Latest commit

 

History

History
38 lines (21 loc) · 912 Bytes

CONTRIBUTING.md

File metadata and controls

38 lines (21 loc) · 912 Bytes
Raw

Contributing to Austin

Thanks for taking the time to contribute or considering doing so.

The following is a set of guidelines for contributing to Austin TUI.

Preamble

TBD

The Coding Style

TBD

Opening PRs

Everybody is more than welcome to open a PR to fix a bug/propose enhancements/ implement missing features. If you do, please adhere to the following styleguides as much as possible.

Git Commit Messages

This styleguide is taken from the Atom project.

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Labels

When opening a new PR, please apply a label to them. Try to use existing labels as much as possible and only create a new one if the current ones are not applicable.