Skip to content

Commit 983aad6

Browse files
committed
Merge branch 'basic-setup' of github.com:MaineC/InnerSourcePatterns into basic-setup
2 parents 296b0bb + 9efa421 commit 983aad6

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

project-setup/base-documentation.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ exactly which colleagues are currently actively maintaining the project.
2323
get setup and get started.
2424
- Project members are spending a lot of time answering getting started
2525
questions.
26-
- Different teams withing the organization have diverging standards for how to
26+
- Different teams within the organization have diverging standards for how to
2727
format source code and which software patterns to use. As a result
2828
contributions often end up getting re-written to a large part or even
2929
entirely.
@@ -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.
@@ -102,4 +111,3 @@ Europace AG, Paypal Inc.
102111
# State
103112

104113
Drafted in December 2019.
105-

0 commit comments

Comments
 (0)