Standards (WIP)

Common standards and guidelines for Code for Australia repositories.

Why Standards

At Code for Australia we believe in Open Source. One of our philosophies is to "Keep it Open by Default".

This repository contains some basic guidelines to help Fellows set up good Open Source projects.

We also recommend reading the Open Source Guide.

Table of contents

• Creating a new repo
• Adding a Readme
• Adding a License

Creating a new repo

// todo

Adding a Readme

Write your own or use the README template as a guide.

The branded Readme also links to Code for Australia's Code of Conduct and Contributing documents.

Adding a License

Choose one that is right for your project, if you're not sure you probably want to use an MIT License.

Github allows you to easily add a License to your repository. You can read their documentation to learn how to do this.