@@ -23,7 +23,7 @@ exactly which colleagues are currently actively maintaining the project.
23
23
get setup and get started.
24
24
- Project members are spending a lot of time answering getting started
25
25
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
27
27
format source code and which software patterns to use. As a result
28
28
contributions often end up getting re-written to a large part or even
29
29
entirely.
@@ -80,6 +80,15 @@ topics:
80
80
* How to submit your modifications back to the project.
81
81
* Some information on which turnaround time to expect for modifications made.
82
82
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
+
83
92
# Resulting Context
84
93
85
94
* The time for contributors to get up to speed is significantly reduced.
@@ -102,4 +111,3 @@ Europace AG, Paypal Inc.
102
111
# State
103
112
104
113
Drafted in December 2019.
105
-
0 commit comments