Skip to content
This repository has been archived by the owner on Aug 26, 2021. It is now read-only.

Latest commit

 

History

History
59 lines (29 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

59 lines (29 loc) · 2.03 KB

Contributing to Australian Government Design System

Hi there! Thank you for your interest in contributing to Australian Government Design System, we really appreciate it.

There are many ways to contribute – reporting bugs, fixing bugs, submitting pull requests for enhancements or even writing documentation.

Wherever you are, and whatever your discipline is, you are invited to contribute.

Contents


Reporting Bugs, Asking Questions, Sending Suggestions

Use the search in issues to see if the same bug, question or suggestion has already been raised.

If you’re filing a bug, specific steps to reproduce are helpful. Please reference the module that has the bug, along with what you expected to see and what happened instead. For more info look at our issue template.

⬆ back to top


Content changes

We use a static site generator called cuttlebelle. This means that all of the content in our site lives in markdown files.

To get started contributing content we recommend editing the files in the content folder.

⬆ back to top


Installing design system locally

If you’d like to contribute code, first, you will need to run design system locally.

💡 Building the design system is only necessary if you want to contribute to it.

npm install
npm run watch

⬆ back to top