diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md new file mode 100644 index 00000000..d8e0fb7c --- /dev/null +++ b/.github/pull-request-template.md @@ -0,0 +1,19 @@ +# Documentation changes + +[Summary of documentation updates] + +# Review and preview + +Have you reviewed and previewed your documentation updates? +In your local repository, +1. Run `make spelling` and fix any spelling issues. +2. Run `make linkcheck` and fix any broken links. +3. Run `make run`. This will build a local copy of the entire documentation and you can preview the updated pages locally before creating this PR. + +## Reviewers + +Make sure to get at least one review from the [Anbox](https://github.com/orgs/canonical/teams/anbox) team. + +# JIRA / Launchpad bug + +[Add the associated JIRA ticket or Launchpad bug ID] \ No newline at end of file