Skip to content

Commit a13be54

Browse files
committed
Define template for optional contributor in N&N entries
Resolves - https://gitlab.eclipse.org/eclipse-wg/ide-wg/community/-/issues/81
1 parent acf62e6 commit a13be54

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

news/instructions.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ Last revised 2025-05-08.
77
### Content Organization
88

99
As of 4.36, New and Noteworthy is authored in markdown.
10+
<!-- TODO: Add link to syntax guide.
11+
- https://spec.commonmark.org/0.31.2/
12+
- https://docs.github.com/en/get-started/writing-on-github
13+
-->
1014

1115
#### Markdown Preview
1216

@@ -36,6 +40,22 @@ you can add a new section to the document to highlight a feature,
3640
but best to add a subsection.
3741
Keep an eye on the automatically-rendered Table of Contents.
3842

43+
#### Template
44+
45+
The following is a template describing the recommended basic structure of a N&N entry:
46+
```
47+
### A notworthy new feature
48+
<!-- Optional link(s) to issues or PRs as invisible comment -->
49+
contributed by [Foo Bar](https://github.com/ghost)
50+
***
51+
52+
Describe the change here. See the instructions in the paragraphs below regarding style recommendation and things to consider.
53+
You can use all markdown features and ,if required and supported, inline HTML.
54+
55+
An image can say more than a thousand words:
56+
![Foo View](images/foo-view.png)
57+
```
58+
3959
### News Item Title and Description
4060

4161
The whole entry should be a blurb pitched to the Eclipse end-user community,
@@ -59,7 +79,7 @@ and don't repeat yourself.
5979
The description should be complete sentences, with trailing punctuation.
6080

6181
Make the entry self-contained and mention API classes.
62-
Do not link to issues and don't promote individuals or third-party products.
82+
Do not link to issues and don't promote third-party products.
6383

6484
Use active voice, i.e., say "you", not "the user",
6585
and follow other advice in [Eclipse Doc Style Guide](https://github.com/eclipse-platform/eclipse.platform/blob/master/docs/Eclipse_Doc_Style_Guide.md#topic-content).
@@ -139,6 +159,14 @@ but the label can be interesting unless it's already part of the description.
139159

140160
Use regular markdown for the image so it can be appropriately rendered and styled.
141161

162+
### Contributor mentioning
163+
164+
The invidividuals that have contributed to a noteworty change _can_ be mentioned as contributors of it.
165+
Contributors should be mentioned below the headline as suggested in the [template](#template).
166+
If somebody else than the author of the N&N entry is listed, that person's consent should be obtained.
167+
All invidividuals who made relevant contributions to the described change should be mentioned as contributors,
168+
but at the same time, the list of contributors should not become too long.
169+
It's the discretion of the entry author to decide what's suitable in each case.
142170

143171
### Initialization
144172

0 commit comments

Comments
 (0)