Skip to content

Commit 9efa421

Browse files
authored
Added links to existing documentation templates
This adds links to external existing documentation on what information to include in a README.md and a contributing guide. While those links point to help for open source projects, most of the information they provide are relevant to InnerSource projects as well.
1 parent c3ef519 commit 9efa421

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

project-setup/base-documentation.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,15 @@ topics:
8080
* How to submit your modifications back to the project.
8181
* Some information on which turnaround time to expect for modifications made.
8282

83+
84+
There are literally tons of good examples for how to write a README.md and what kind
85+
of information to include in a CONTRIBUTING.md file in various open source projects.
86+
Pages like [how to write a readme that rocks](https://m.dotdev.co/how-to-write-a-readme-that-rocks-bc29f279611a),
87+
[Open Source Guide from GitHub](https://opensource.guide/) as well as
88+
the book [Producing Open Source](https://producingoss.com/en/producingoss.html) all
89+
have valuable information on what kind of information to provide. In addition to that this
90+
pattern comes with two very basic templates to get you started right away.
91+
8392
# Resulting Context
8493

8594
* The time for contributors to get up to speed is significantly reduced.

0 commit comments

Comments
 (0)