
Contributing Guide
Docs + Word8 pages
Free
Shared code stalls when people from other teams do not know how to propose a change, who will review it or how long the wait will be. This guide sets out the inner source path in seven pages: principles, owners, the proposal route, the review process and where to get help. It is written so a contributor can start in an afternoon without asking anyone first.
The sample is for Brindlewick Systems, a fictional software company that shares repositories across teams. Its figures, owners and contacts are sample data: 87.5 percent of pull requests pass CI before review, and owners reply within three working days. Replace the project name, licence and contacts, then test every set-up step on a clean machine.
Click Make a copy in Google Docs, then confirm on the Google page. The copy is saved to your own Google Drive.
Replace the project name, repository links and licence on the first page with your own.
Run the set-up steps on a fresh machine, then correct any command that fails.
Label real good first issues and link them in the guide for newcomers to pick up.
Delete the guide page, name a conduct contact, then share the guide with contributors.
Yes. Make a copy at no charge and the guide sits in your Drive, ready for your repository's own owners and links.
No. Brindlewick Systems, its maintainers, phone numbers and email addresses are fictional sample data. Replace every contact with real, monitored addresses before you publish.
No. The guide explains how to contribute, but your licence and contribution terms should be written by legal counsel and linked from the repository.
More Google Docs templatesMore developer workflows templates

Docs + Word8 pages
Free
Docs + Word7 pages
Free
Slides + PowerPoint11 slides
Free