Skip to main content
Private Cloud as a Service Platform Technical Documentation

Required pages for a GitHub repository

When you create a repository in the bcgov organization, add the following markdown files:

  • License
  • README
  • Code of conduct
  • Contribution guidelines

On this page

Licence

Choose a licence and place a licence file in your repository before you do anything else. For important information on licences, see License your GitHub repository.

Depending on the licence you choose, add boilerplate text for the applicable licence to your README file.

ReadMe

GitHub has extensive documentation on how to create a good README file for your repository. Follow these guidelines when you create your README.

For more information, see About READMEs.

Make sure to include the following:

  • A brief description of your project
  • An overview on how to contribute to the repository with a link to your contribution guidelines
  • Depending on your licence, boilerplate text for the applicable licence. For more information, see License your GitHub repository
  • A link to your code of conduct file

See a sample README file.

Code of conduct

Write a clear code of conduct to ensure contributors to your project foster an open and welcoming environment.

Two good starting points to create a code of conduct for your project are the Contributor Covenant and GitHub's guidelines on healthy contributions.

See a sample code of conduct file.

Contribution guidelines

Write concise and clear contribution guidelines. Let potential contributors know how you prefer they work on projects and give them the correct information to do so.

For example, if you prefer contributors fork repositories and submit pull requests, provide links to the applicable documentation.

Make sure you're clear on the licence that applies to your repository and provide a link to relevant documentation.

See a sample contributing file.

Related links: