-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.md.template
More file actions
60 lines (40 loc) · 2.55 KB
/
README.md.template
File metadata and controls
60 lines (40 loc) · 2.55 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
{{- /* README.md template - generated using https://coveooss.github.io/gotemplate/ */ -}}
[](LICENSE.md)
# 2Alchemists GitHub Labels
> The way we set up GitHub labels for our projects at [2Alchemists](https://2alchemists.com).
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](LICENSE.md) file for more details.
## Purpose
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](https://medium.com/{{"@"}}dave_lunny/sane-github-labels-c5d2e6004b63) 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.
## Format of labels
The labels are specified as JSON files, ready to be used with [popomore/github-labels](https://github.com/popomore/github-labels).
## Labels
These are the labels already defined.
### Domain
| Name | Color |
|------------------|------------|
{{ range .domain -}}
| `{{ .name }}` | ![{{ .color }}](https://via.placeholder.com/15/{{ trimPrefix "#" .color }}/000000?text=+) `{{ .color }}` |
{{ end }}
### Priority
| Name | Color |
|------------------|------------|
{{ range .priority -}}
| `{{ .name }}` | ![{{ .color }}](https://via.placeholder.com/15/{{ trimPrefix "#" .color }}/000000?text=+) `{{ .color }}` |
{{ end }}
### Type
| Name | Color |
|------------------|------------|
{{ range .type -}}
| `{{ .name }}` | ![{{ .color }}](https://via.placeholder.com/15/{{ trimPrefix "#" .color }}/000000?text=+) `{{ .color }}` |
{{ end }}
## How to use
See [documentation](https://github.com/popomore/github-labels) for installation and usage of [popomore/github-labels](https://github.com/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](https://github.com/settings/tokens)).
To apply the labels on a specific repository `user/repo`, type the following command:
```sh
$ ls src/*.json | xargs -I{} labels -c {} -f user/repo
```
## Related
- [GitHub API - Labels](https://developer.github.com/v3/issues/labels)
- [popomore/github-labels - Add GitHub labels automatically](https://github.com/popomore/github-labels)
- [Sane GitHub Labels – Dave Lunny – Medium](https://medium.com/{{ "@" }}dave_lunny/sane-github-labels-c5d2e6004b63)