This repo describes the way we set up GitHub labels for our projects at NewAperio. These are the labels we use with Custodian, our GitHub bot. The JSON files are designed to be used with git-labelmaker.
Note: This step is only necessary if it's a repo not under our organization. The repos in our organization get these labels by default.
In a new repo, you probably want to first delete GitHub's default labels:
git-labelmaker # then select option 4 "Remove All Labels"Then you can create labels using one of the sets here. Clone the repo and then run the command:
git-labelmaker # then select option 2 "Add Labels From Package"
# provide *full* filepath to one of the JSON files
# e.g. /Users/newaperio/code/github-labels/code.jsonThese are the labels we use on repos that contain the main working code for our projects.
Since we don't use GitHub for project management, the labels only describe Pull Request statuses.
| Name | Color | Description |
|---|---|---|
blocked |
orange | Dependency needs to be cleared before progress can be made |
in-progress |
purple | Work is ongoing or pending (applied by Custodian) |
needs-review |
yellow | Work is finished; awaiting code review (applied by Custodian) |
question |
magenta | Outstanding discussion needs resolution |
ready-to-merge |
green | Work is finished and reviewed; awaiting merge (applied by Custodian) |
This repo is Copyright © 2017 NewAperio. It is free software, and may be redistributed under the terms specified in the LICENSE file.
This repo was written by NewAperio, LLC.
NewAperio is a web and mobile design and development studio. We offer expert software design and development as part of our portfolio of services. Get in touch to see how our team can help you.