Skip to content
This repository has been archived by the owner on Mar 5, 2018. It is now read-only.

Latest commit

 

History

History
44 lines (27 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 2.64 KB

Welcome!

We're so glad you're thinking about contributing to the Gov AU UI Kit. The UI Kit is an evolving project and relies on help and feedback to improve.

Found a bug while using the framework or guide? Let us know by raising an issue.

Have a suggestion for a new feature? If you can reach us on Slack, visit us in #guides-uikit and let us know. If you're not on Slack, that's fine, just open an issue

If your suggestion is not already in our roadmap, we'll probably suggest that you make a fork of our repo and then open a pull request so that we can review your changes or additions and hopefully merge them in.

We encourage you to read our Contributor Code of Conduct. By ensuring that all staff and contributors follow this guide we can maintain an inclusive and friendly environment.

We've also put together some Coding Convention guidelines which explain our code style and linting.

Finally, if you're unsure about anything, just ask — or submit your issue or pull request anyway. The worst that can happen is we'll politely ask you to change something. We appreciate all friendly contributions.

Guidelines

Submitting an issue

Submitting a pull request

To help us get a better understanding of the issue you're submitting, follow our ISSUE TEMPLATE and the guidelines it describes.

Submitting a pull request

Here are a few guidelines to follow when submitting a pull request:

  1. Create a GitHub account or sign in to your existing account.
  2. Fork this repo into your GitHub account (or just clone it if you're an AusDTO team member). Read more about forking a repo here on GitHub: https://help.github.com/articles/fork-a-repo/
  3. Create a branch that lightly defines what you're working on, prefixed with '/feature' (for example, feature/add-styles).
  4. Ensure that your contribution passes a gulp build.prod.
  5. Once you're ready to submit a pull request, fill out the PULL REQUEST template provided.
  6. Submit your pull request against the develop branch.

Have questions or need help with setup? Open an issue here https://github.com/AusDTO/gov-au-ui-kit/issues.

This guide is adapted from 18F's Contributing Guide