The way we set up GitHub labels for our projects at 2Alchemists.
This project is open sourced under the terms of the Creative Commons Attribution 4.0 International Public License (also known as CC-BY). See the LICENSE file for more details.
The default GitHub labels may be fine for some projects, but we think they can be greatly improved by adding our own labels.
Dave Lunny has written a great article about a sane labelling scheme, and this repository takes up most of the ideas in the article, adapting them to our way of working and organizing.
The labels are specified as JSON files, ready to be used with popomore/github-labels.
These are the labels already defined.
| Name | Color |
|---|---|
Domain: 🎛 Config |
#b56edd |
Domain: 👩💻 Dev Experience |
#18e295 |
Domain: 📝 Documentation |
#514fe2 |
Domain: ⚡️ Performance |
#f74fdb |
Domain: 🛡 Security |
#0c58d3 |
Domain: 🧪 Testing |
#86f411 |
Domain: 🛠 Tooling |
#fbca04 |
Domain: 🎨 User Experience |
#f4cfb0 |
| Name | Color |
|---|---|
Priority: ⚪️ Low |
#009800 |
Priority: 🔵 Medium |
#fbca04 |
Priority: 🔴 High |
#d73a4a |
Priority: 🚨 Critical |
#e11d21 |
| Name | Color |
|---|---|
Type: 🐛 Bug |
#e11d21 |
Type: 🔨 Maintenance |
#fbca04 |
Type: ✨ Enhancement |
#84b6eb |
Type: ❓ Question |
#cc317c |
See documentation for installation and usage of popomore/github-labels, especially when using a Gitbub Enterprise instance for which you'll need to pass some additional parameters (like a Personal Access Token).
To apply the labels on a specific repository user/repo, type the following command:
$ ls src/*.json | xargs -I{} labels -c {} -f user/repo