From charlesreid1

Revision as of 12:04, 22 October 2017 by Admin (talk | contribs) (→‎Overview)

Also see: Github

Overview

This page covers the basic components of a Github package that is bundled up and released on a regular basis. These components are:

  • Testing
  • Releases
  • Branches
  • Issues
  • Bots (for maintenance/other)

Testing

Continuous integration testing is essential for ensuring consistent behavior of any package. If a package is open source, Travis can be used to run tests for free.

Releases

Tagging is the process of picking a particular state of the repo, and creating a git tag with a version number.

Branches

This is mostly a git thing, but maintaining multiple branches to aid development requires some care and forethought. This basically requires the use of git patterns.

Issues

Some of the things you want to do for issues include:

  • Create useful labels for categorizing issues
  • Create bots that label, comment on, or close issues

Flags