You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -36,6 +40,22 @@ you can add a new section to the document to highlight a feature,
36
40
but best to add a subsection.
37
41
Keep an eye on the automatically-rendered Table of Contents.
38
42
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
+

57
+
```
58
+
39
59
### News Item Title and Description
40
60
41
61
The whole entry should be a blurb pitched to the Eclipse end-user community,
@@ -59,7 +79,7 @@ and don't repeat yourself.
59
79
The description should be complete sentences, with trailing punctuation.
60
80
61
81
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.
63
83
64
84
Use active voice, i.e., say "you", not "the user",
65
85
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.
139
159
140
160
Use regular markdown for the image so it can be appropriately rendered and styled.
141
161
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.
0 commit comments