Skip to content

Commit f318e8c

Browse files
authored
Refactor scriv factor template (#30)
1 parent 4ad237c commit f318e8c

File tree

2 files changed

+17
-19
lines changed

2 files changed

+17
-19
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
Changed
3+
-------
4+
5+
* Modify the scriv changelog fragment template.
Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,21 @@
1-
..
21

3-
Please select the correct category for the change you are making.
2+
Changelog Writing Instructions:
43

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.
85

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).
108

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.
1410

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."
2015

2116
{% 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) }}
2619

27-
* Describe your "{{ category }}" change here. EDIT ME!
20+
* Describe your "{{ category }}" change here. EDIT ME!
2821
{% endfor -%}

0 commit comments

Comments
 (0)