Contribute

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

Bugs and issues

We use the GitHub issues to track all our bugs and feature requests.

When submitting a new issue, 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.

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 origin/master to upstream/master.

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.

Running tests locally

Before proposing a pull request, ensure that the tests pass on your local fork. To kick off the tests, run ./run test.

Licences

The content of this project is licensed under the Creative Commons Attribution-ShareAlike 4.0 International license, and the underlying code used to format and display that content is licensed under the LGPLv3 by Canonical Ltd.

Last updated: