Skip to content

Commit 6ed9f80

Browse files
committed
Add templates for initial project documentation.
These templates are meant to be used as a starting point for creating project documentation. Likely for smaller projects following standard coding practices their content can be reduced. The more experience the project has with working with contributors the more helpful those documents will get.
1 parent 6f2e99f commit 6ed9f80

File tree

2 files changed

+113
-0
lines changed

2 files changed

+113
-0
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing to ____
2+
3+
## Types of contributions
4+
5+
Provide information on what kinds of contributions your project is looking for
6+
here. For example these can be bug reports, help with answering user questions,
7+
improving documentation, fixes to bugs, as well as new feature implementations.
8+
9+
## Bug reports
10+
11+
Add information on how to submit bug reports here. This should include
12+
hints about which type of information the project will need in order to
13+
reproduce and fix issues. It can also include information on commonly found
14+
mis-configurations that look like bugs.
15+
16+
Also include information on what contributors can expect in terms of time to
17+
first response and process after that.
18+
19+
## Feature requests
20+
21+
Add information on how to submit feature requests here. Also include information
22+
on what contributors can expect in terms of time to first response and process
23+
after that.
24+
25+
## Contributing documentation
26+
27+
Include information on any documentation best practices your project follows as
28+
well as how to build documentation, checks to run and how to submit the changes
29+
made back to the project.
30+
31+
## Contributing source code
32+
33+
This section should contain information on
34+
35+
- How to access the project source code,
36+
- General project layout,
37+
- Any requirements to the development environment,
38+
- Code formatting guidelines,
39+
- How to run the test suite.
40+
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Insert the name of your project here
2+
3+
## Mission
4+
5+
This should contain a brief (3-5 sentences) description of the mission of your
6+
project. The goal is to state what you are planning to work on and help external
7+
contributors understand roughly which types of features will likely be welcome
8+
for this project.
9+
10+
See also [mission statement
11+
chapter](https://producingoss.com/en/producingoss.html#mission-statement) in
12+
Producing Open Source Software.
13+
14+
## Getting Started
15+
16+
This section should contain brief documentation written for first time users on
17+
how to get started using the project. Further more detailed documentation can be
18+
linked to from here.
19+
20+
## Getting involved
21+
22+
This section should include information on how to get in touch with the project:
23+
Typically this will contain links to archived, searchable and linkable
24+
communication channels.
25+
26+
## Who we are
27+
28+
This is a good place to give credit to Trusted Committers of the project.
29+
30+
It's also a good place to include information on what being a Trusted Committer
31+
means for this project - although ideally all projects in an organisation use
32+
the same definition that is only linked to from here. The reason to keep the
33+
link here is for colleagues who have no or little experience with working in and
34+
contributing to InnerSource projects to have a direct link back to company wide
35+
information from the technological projects they need for their daily work.
36+
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+
## Contributing
50+
51+
This section should document (or link to documentation) on all things that a
52+
first time contributor needs to know to get started. Typically not all of the
53+
topics below will be covered. Focus on what differs in your project from
54+
standard setup and what previous contributors found hard to understand.
55+
56+
- Finding the source code.
57+
- Finding a list of issues that your project needs help with - these can be
58+
both, technical and non-technical issues. Typically you will keep those in an
59+
issue tracker accessible to contributors.
60+
- Links to further documentation e.g. about the architecture of the project,
61+
general coding conventions, testing conventions...
62+
- For technical contributions: Making changes, building the project and testing
63+
your changes.
64+
- Submitting your changes back to the project.
65+
66+
Ideally you also include information on what the preferred process for changes
67+
looks like for the project: Should contributors first open an issue and submit a
68+
proposal, or are they welcome to submit changes right away? What is important to
69+
you when reviewing contributions?
70+
71+
Over time you will notice that this section grows substantially. In that case
72+
think about moving the information to separate files, e.g. a CONTRIBUTING.md and
73+
TESTING.md

0 commit comments

Comments
 (0)