Skip to content
This repository was archived by the owner on Sep 11, 2024. It is now read-only.

Commit 3dcea5c

Browse files
authored
docs: how to update labels (#3)
1 parent 5cd23a6 commit 3dcea5c

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Template repo with docs and GitHub Actions etc, to create other projects.
44

5+
![screenshot](https://user-images.githubusercontent.com/624760/113267767-9e331c00-92ce-11eb-8e47-efb02d3c7fa2.png)
6+
57
## Usage
68

79
```yaml
@@ -27,4 +29,31 @@ jobs:
2729
repository-name: 'gh-action-open-source-labels'
2830
```
2931
30-
![screenshot](https://user-images.githubusercontent.com/624760/113267767-9e331c00-92ce-11eb-8e47-efb02d3c7fa2.png)
32+
## Label standards
33+
34+
> To facilitate the community in finding ways to contribute that match their experiences and skillsets, we have developed a comprehensive system for labelling issues and PRs. This is an introduction to this standard labelling scheme.
35+
36+
> Labels consist of three fields, viz. name, description and color. Label names should have a consistent format to aid both filtering within the github UI as well as scanning visually through the list. The following format is the most suited to this task (where ⎵ denotes a single space):
37+
38+
```
39+
<emoji>⎵<category>:⎵<name>
40+
```
41+
42+
Using the label convention from https://opensource.creativecommons.org/contributing-code/repo-labels/
43+
44+
## How to update the labels
45+
46+
To add a new label, update the `labels.json` file and the GitHub Action will do the rest.
47+
48+
```json
49+
[
50+
{
51+
"name": "good first issue",
52+
"color": "7f0799"
53+
},
54+
{
55+
"name": "help wanted",
56+
"color": "7f0799"
57+
}
58+
]
59+
```

0 commit comments

Comments
 (0)