# Contributing to Vanilla framework

So, you'd like to contribute to Vanilla framework? Great!

## Table of contents

- [Code of conduct](#code-of-conduct)
- [Reporting bugs and issues](#reporting-bugs-and-issues)
- [Working with the Vanilla project](#working-with-the-vanilla-project)
- [Pull requests](#pull-requests)
- [Releasing Vanilla](#releasing-vanilla)

## [Code of Conduct](/CODE_OF_CONDUCT.md)

As developers and maintainers of the Vanilla project, we follow a [Code of Conduct](/CODE_OF_CONDUCT.md), and ask that all contributors do the same.

## Reporting bugs and issues

We use the [GitHub issues](https://github.com/canonical/vanilla-framework/issues) to track all our bugs and feature requests.

When [submitting a new issue](https://github.com/canonical/vanilla-framework/issues/new/choose), please check that it hasn't already been raised by someone else. We've provided a template for new issues which will help you structure your issue to ensure it can be picked up and actioned easily.

Please provide as much information possible detailing what you're currently experiencing and what you'd expect to experience.

## [Working with the Vanilla project](/guides/hacking.md)

- [Running the project](/guides/hacking.md#running-the-project)
- [Viewing documentation and examples](/guides/hacking.md#viewing-documentation-and-examples)
- [QA testing](/guides/hacking.md#qa-testing)
- [Adding new icons](/guides/hacking.md#adding-new-icons)

## [Pull requests](/guides/pull-requests.md)

- [Working on an issue](/guides/pull-requests.md#working-on-an-issue)
- [Preparing a pull request for review](/guides/pull-requests.md#preparing-a-pull-request-for-review)

## [Releasing Vanilla](/guides/release-process.md)

- [Pre release tasks](/guides/release-process.md#pre-release-tasks)
- [Releasing](/guides/release-process.md#releasing)
- [Deploying vanillaframework.io](/guides/release-process.md#deploy-vanillaframeworkio)
- [Releasing React Components](/guides/release-process.md#react-components)
- [Promotion](/guides/release-process.md#promotion)

## Licenses

The content of this project is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International license](https://creativecommons.org/licenses/by-sa/4.0/), and the underlying code used to format and display that content is licensed under the [LGPLv3](http://opensource.org/licenses/lgpl-3.0.html) by [Canonical Ltd](http://www.canonical.com/).