contribute.html

---
layout: default
desc: Vanilla Framework contribution guidelines
sitemap:
    priority: 1.0
    changefreq: 'monthly'
    lastmod: 2017-07-03T17:20:30+00:00
---

<div class="p-strip is-deep">
  <div class="row">
    <div class="col-8">
      <h1>Contribute</h1>
      <p>So, you'd like to contribute to Vanilla Framework? Great!</p>
      <h2>Bugs and issues</h2>
      <p>We use the <a class="p-link--external" href="https://github.com/vanilla-framework/vanilla-framework/issues">GitHub issues</a> to track all our bugs and feature requests.</p>
      <p>When <a class="p-link--external" href="https://github.com/vanilla-framework/vanilla-framework/issues/new">submitting a new issue</a>, 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.</p>
      <p>Please provide as much information possible detailing what you're currently experiencing and what you'd expect to experience.</p>
      <p>To work on an issue, please fork this repo and create a new branch on your local fork. When you're happy and would like to propose that changeset to be merged back upstream, open a pull request to merge from your local <code>origin/master</code> to <code>upstream/master</code>.</p>
      <p>When committing changes, make sure to group related changes so that the project is always in a working state. Use succinct yet descriptive commit messages to allow for easy reading of the commit log.</p>
      <h2>Running tests locally</h2>
      <p>Before proposing a pull request, ensure that the tests pass on your local fork. To kick off the tests, run <code>./run test</code>.</p>
      <h2>Licences</h2>
      <p>The content of this project is licensed under the <a class="p-link--external" href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International license</a>, and the underlying code used to format and display that content is licensed under the <a class="p-link--external" href="http://opensource.org/licenses/lgpl-3.0.html">LGPLv3</a> by <a class="p-link--external" href="http://www.canonical.com/">Canonical Ltd.</a></p>
      <p>Last updated: <time>{{ page.sitemap.lastmod | date: '%d %B %Y'}}</time></p>
    </div>
  </div>
</div>