Contributing

This is all the documentation for contributing to the project.

Setting up your dev environment

Pull the repo

git clone git@github.com:uktrade/govuk-frontend-django.git

We use poetry to manage our package and it's dependencies

poetry install

Writing documentation

Documentation for this project is written in markdown and is generated using mkdocs. It can be found in the docs directory.

To run the documentation locally, run the following command:

make serve-docs

Submitting a pull request

TODO: Add some guidelines for submitting a pull request