Skip to content
The first pages of the Project README Template template

Project README Template

Document template for Google Docs and Word

Make a copy in Google Docs
Price
Free
Style
Minimal
Difficulty
Beginner
Updated
November 12, 2026

Every page (8)

Overview

Open source projects lose contributors who cannot get a build running, or who wait weeks for a reply without knowing why. This template sets out the contributing guide in the order a newcomer needs it: the purpose, the install steps, usage, configuration, the contribution policy and the licence. Each section answers one question a first-time contributor would otherwise have to ask on a public issue.

The sample is for Kestrel CLI, a fictional command-line tool maintained by Fallowfield Systems, with set-up steps that take a fresh machine to a passing test run in about fifteen minutes. It shows a usage scorecard, a configuration reference, a policy page and a pricing page for paid support. Replace the project name, commands, maintainer names and licence with your own, then run every install step on a clean machine before you publish.

Useful for

  • A maintainer answering the same set-up question for the fourth time this month
  • A first-time contributor preparing a pull request for a small fix
  • A company legal team checking the licence and contribution terms before adoption

What's included

  • Cover page and purpose page with headline figures and expectations
  • Install page with four timed steps, checks and a tip callout
  • Usage scorecard with targets, trends and status notes
  • Configuration page with a settings table and an example block
  • Contribution policy with definitions, duties and a key rule
  • Licence page with plan cards and validity notes, plus a make it yours guide

How to use it

  1. 1

    Click Make a copy in Google Docs, then confirm on the Google page. The copy is saved to your own Google Drive.

  2. 2

    Rename the project and the repository links on the first page before anyone reads the guide.

  3. 3

    Run every install step on a fresh machine, and correct any command or time that does not match.

  4. 4

    Label real good first issues, then link them from the contributing page.

  5. 5

    Delete the guide page, then share the guide in the repository and link it from the README.

What you need

Requirements

  • A Google account with access to Google Drive

Works with

  • Google Docs
  • Microsoft Word (download the .docx)

Questions

Are the organisation, people and figures fictional?

Yes. Fallowfield Systems, the Kestrel CLI project, its maintainers, email addresses, prices and usage figures are fictional. Replace them with your own details before publishing the guide.

How long should a contributing guide be?

Long enough to answer the questions newcomers ask most, and no longer. Keep set-up to a few minutes of reading and link to detailed design notes rather than pasting them in.

Should the guide name real maintainers and response times?

Yes, and state them honestly. A stated turnaround of seven working days is far better than an unstated one that people quietly wait for. Update the figures whenever the review rota changes.

  • #contributing-guide
  • #contributing-md-template
  • #open-source-contribution
  • #code-of-conduct
  • #open-source-governance
  • #developer-onboarding

More contributing guide templates

See all 8

Also in Developer workflows

All developer workflows templates
Get this template

Preparing your template…