Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 1.06 KB

contributing.md

File metadata and controls

25 lines (21 loc) · 1.06 KB

Main Authors

Branches

Syntax
devname = first name of the developer
issuenumber = the number of the issue that the branch is completing.
short-description = a short, dash-separated description of the branch (shouldn't be more than ~40 characters)

Branch name formatting should be as follows:

  • If there is a relevant, single Issue that the branch will completely solve:
    devname/issuenumber/short-description
    e.g. logan/21/pull-out-base-class-functionality

  • If the branch wraps up multiple Issues or has no associated Issue:
    devname/short-description
    e.g. logan/readme-updates

Pull Requests & Issues

  • If a PR directly closes one or more issues, those issues should be listed in the description with one of the auto-closing prefixes as described here.
    e.g. "Closes #15: Refactored constants into a package with top-level classes."