Skip to content

Commit cca8d68

Browse files
docs: mention description limitations (#261)
* Better informed users of limitations in GitHub label calls in documentation * docs: minor formatting changes --------- Co-authored-by: Federico Grandi <[email protected]>
1 parent 30af982 commit cca8d68

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ How to create a config file:
6464
- Every label should be an array element: add some square brackets `[]` if you need to.
6565
- Every element of the array should be an object with the following properties:
6666
- `name` - The name of the label.
67-
- `color` - The color of the label.
68-
- `description` - [optional] The description of the label.
67+
- `color` - The color of the label, with or without a leading `#`.
68+
- `description` - [optional] The description of the label ([max 100 characters](https://docs.github.com/en/rest/issues/labels?apiVersion=2022-11-28#create-a-label)).
6969
- `aliases` - [optional] An array containing the "aliases" of the label. If an existing label's name is an alias that label will be edited to match your config: this way you don't loose issues and PRs that have been labeled previously.
7070

7171
This is how it would end up looking:

0 commit comments

Comments
 (0)