@@ -17,6 +17,14 @@ This section should contain brief documentation written for first time users on
17
17
how to get started using the project. Further more detailed documentation can be
18
18
linked to from here.
19
19
20
+ ## Getting help
21
+
22
+ This section should contain a brief documentation on how to get help for the
23
+ project as a user. This could be as simple as pointing users to the issue
24
+ tracker if this is how your project would like to answer questions. It could
25
+ also point to an archived and searchable chat channel, some archived searchable
26
+ mailing list, some online user forum.
27
+
20
28
## Getting involved
21
29
22
30
This section should include information on how to get in touch with the project:
@@ -34,18 +42,6 @@ link here is for colleagues who have no or little experience with working in and
34
42
contributing to InnerSource projects to have a direct link back to company wide
35
43
information from the technological projects they need for their daily work.
36
44
37
- ### How to become a Trusted Committer
38
-
39
- This section should make the process for becoming a Trusted Committer explicit
40
- if that route is open to contributors.
41
-
42
- ### How to nominate Trusted Committers
43
-
44
- This section serves as a reminder to existing and explanation for new Trusted
45
- Committers detailing how to add others to the host team. Again ideally this
46
- information is identical for all projects in the organisation so central
47
- information can be linked to from here.
48
-
49
45
## Contributing
50
46
51
47
This section should document (or link to documentation) on all things that a
@@ -68,6 +64,11 @@ looks like for the project: Should contributors first open an issue and submit a
68
64
proposal, or are they welcome to submit changes right away? What is important to
69
65
you when reviewing contributions?
70
66
67
+ In addition you should outline any design values you want to follow in the
68
+ project. Making those explicit often helps resolve trade-offs more quickly and
69
+ more easily. In addition it helps making changes to otherwise implicit
70
+ assumptions transparent.
71
+
71
72
Over time you will notice that this section grows substantially. In that case
72
73
think about moving the information to separate files, e.g. a CONTRIBUTING.md and
73
74
TESTING.md
0 commit comments