Skip to content

Commit 296b0bb

Browse files
committed
Refine according to review.
This moves the "becoming a committer" section to the contributing doc. It also adds a section on getting help. In addition it adds a requirement to make project design values explicit to the contributing section.
1 parent 6ed9f80 commit 296b0bb

File tree

2 files changed

+24
-12
lines changed

2 files changed

+24
-12
lines changed

project-setup/templates/CONTRIBUTING-template.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,14 @@ This section should contain information on
3838
- Code formatting guidelines,
3939
- How to run the test suite.
4040

41+
## How to become a Trusted Committer
42+
43+
This section should make the process for becoming a Trusted Committer explicit
44+
if that route is open to contributors.
45+
## How to nominate Trusted Committers
46+
47+
This section serves as a reminder to existing and explanation for new Trusted
48+
Committers detailing how to add others to the host team. Again ideally this
49+
information is identical for all projects in the organisation so central
50+
information can be linked to from here.
51+

project-setup/templates/README-template.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ This section should contain brief documentation written for first time users on
1717
how to get started using the project. Further more detailed documentation can be
1818
linked to from here.
1919

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+
2028
## Getting involved
2129

2230
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
3442
contributing to InnerSource projects to have a direct link back to company wide
3543
information from the technological projects they need for their daily work.
3644

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-
4945
## Contributing
5046

5147
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
6864
proposal, or are they welcome to submit changes right away? What is important to
6965
you when reviewing contributions?
7066

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+
7172
Over time you will notice that this section grows substantially. In that case
7273
think about moving the information to separate files, e.g. a CONTRIBUTING.md and
7374
TESTING.md

0 commit comments

Comments
 (0)