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
See also [GitHub's writing documentation](https://docs.github.com/en/get-started/writing-on-github).
10
16
11
17
#### Markdown Preview
12
18
@@ -36,6 +42,23 @@ you can add a new section to the document to highlight a feature,
36
42
but best to add a subsection.
37
43
Keep an eye on the automatically-rendered Table of Contents.
38
44
45
+
#### Template
46
+
47
+
The following is a template describing the recommended basic structure of a N&N entry:
48
+
```
49
+
### A notworthy new feature
50
+
<!-- Optional link(s) to issues or PRs as invisible comment -->
51
+
contributed by [John Doe](https://github.com/ghost)
52
+
***
53
+
54
+
Describe the change here.
55
+
See the instructions in the paragraphs below regarding style recommendation and things to consider.
56
+
You can use all markdown features and, if required and supported, inline HTML.
57
+
58
+
An image can say more than a thousand words:
59
+

60
+
```
61
+
39
62
### News Item Title and Description
40
63
41
64
The whole entry should be a blurb pitched to the Eclipse end-user community,
@@ -59,7 +82,7 @@ and don't repeat yourself.
59
82
The description should be complete sentences, with trailing punctuation.
60
83
61
84
Make the entry self-contained and mention API classes.
62
-
Do not link to issues and don't promote individuals or third-party products.
85
+
Do not link to issues and don't promote third-party products.
63
86
64
87
Use active voice, i.e., say "you", not "the user",
65
88
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 +162,16 @@ but the label can be interesting unless it's already part of the description.
139
162
140
163
Use regular markdown for the image so it can be appropriately rendered and styled.
141
164
165
+
### Contributor Mentioning
166
+
167
+
The individuals that have contributed to a noteworthy change _can_ be mentioned as contributors of it.
168
+
Contributors should be mentioned below the headline, and the name of each contributor can be backed by a link to that person's GitHub profile as suggested in the [template](#template).
169
+
It's recommended to use real full names, in the spirit of an open and transparent community, but if desired, a contributor's pseudonym can be used as well.
170
+
If anybody other than the author of the N&N entry is listed, that person's consent should be obtained
171
+
(for regular contributors, who have been mentioned in other entries already, general consent can be assumed and it's sufficient to make them aware of a new entry with the possibility to object).
172
+
Every individual who made code contributions to the described change should be mentioned as contributors (if consented).
173
+
If too many people contributed to a change and the list becomes too long it can be [collapsed](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections)
0 commit comments