|
1 | | -.. |
2 | 1 |
|
3 | | - Please select the correct category for the change you are making. |
| 2 | +Changelog Writing Instructions: |
4 | 3 |
|
5 | | - 1. Remove all lines before and after the chosen category |
6 | | - including these instructions and the divider lines that |
7 | | - use tildes ("~"). |
| 4 | +1. Select the category that best fits your change. |
8 | 5 |
|
9 | | - 2. Remove the four spaces in front of the remaining text. |
| 6 | +2. Delete all text from your file outside your category's section (including this |
| 7 | + instruction block). |
10 | 8 |
|
11 | | - 3. Describe your change using active verbs and full sentences. |
12 | | - For example, write "Support a new feature" instead of |
13 | | - "Supports a new feature" or "A new feature is supported". |
| 9 | +3. Edit the remaining bullet point to describe your change. |
14 | 10 |
|
15 | | - 4. If your change is associated with an issue on GitHub, |
16 | | - list the issue number(s) in parentheses, separated by |
17 | | - commas. For example: |
18 | | - |
19 | | - Support a new feature. (#10, #20) |
| 11 | + * For changelog consistency, use present-tense, active verbs: |
| 12 | + ✅ "Add support for a new feature." |
| 13 | + ❌ "Added support for a new feature." |
| 14 | + ❌ "A new feature is supported." |
20 | 15 |
|
21 | 16 | {% for category in config.categories %} |
22 | | - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
23 | | - |
24 | | - {{ category }} |
25 | | - {{ config.rst_header_chars[1] * (category|length) }} |
| 17 | +{{ category }} |
| 18 | +{{ config.rst_header_chars[1] * (category|length) }} |
26 | 19 |
|
27 | | - * Describe your "{{ category }}" change here. EDIT ME! |
| 20 | +* Describe your "{{ category }}" change here. EDIT ME! |
28 | 21 | {% endfor -%} |
0 commit comments