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.
- Before you start
- Initial set up
- Reporting Bugs, Sending Suggestions
- Content changes
- Installing design system locally
Before you begin experimenting with the Design System site it is recommended that you undertake the Cuttlebelle tutorials. These will give you a good idea on how to create new pages and layouts. ⬆ back to top
To set up the Design System site locally, do the following.
- Visit the design system site repository
- Clone or download the repository to your local machine.
- Open the terminal and navigate to where you have saved the repository.
- Enter
npm installto install the components. - Enter
npm run watch. A local instance of the website will launch in your browser.
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.
We use a static site generator called cuttlebelle. This means that all of the content in our site lives in markdown files.
To contribute content we recommend first editing the files in the content folder.
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