DEV Community

loading...

How to set up GitHub/GitLab issue and PR templates

Giulia Chiola
Front-end Developer. 👾 Media engineer. ⚡ Facing life one bug at a time. 🔥 Easily bribed with chocolate. 🍫 she/her.
Originally published at giuliachiola.dev Updated on ・2 min read

Templates for both GitLab and GitHub

Use the content that works best for you, here there are mine.

Template Snippet
issue 🐙 GitHub snippet
pull request / merge request 🐙 GitHub snippet
release 🐙 GitHub snippet

Basic

GitHub

  • Create .github folder in project root.
  • Add templates files following this folder structure
├── .gitlab/
│   ├── ISSUE_TEMPLATE/
│   │   ├── issue-templates.md
│   ├── PULL_REQUEST_TEMPLATE/
│   │   ├── merge-request-templates.md
│   ├── RELEASE_TEMPLATE/
│   │   ├── release-templates.md
Enter fullscreen mode Exit fullscreen mode
  • Commit and push on our default branch.

  • Check our project on GitHub. From now on, when we will open an issue, it will be pre-compiled with the markdown template we added.

issue template 01

issue template 02

GitLab

In GitLab is pretty much the same, but here we have to create a folder named .gitlab, and add this folders structure:

├── .gitlab/
│   ├── issue_templates/
│   │   ├── issue-templates.md
│   ├── merge_request_templates/
│   │   ├── merge-request-templates.md
│   ├── release_templates/
│   │   ├── release-templates.md
Enter fullscreen mode Exit fullscreen mode

Advanced

If we need different templates to choose, we have to add folders instead of files, and add many files as we need.

├── .github
│   ├── ISSUE_TEMPLATE
│   │   ├── bug-report.md
│   │   ├── feature.md
│   │   ├── nice-to-have.md
│   ├── PULL_REQUEST_TEMPLATE.md
│   ├── RELEASE_TEMPLATE
│   │   ├── default.md
│   │   ├── hotfix.md
Enter fullscreen mode Exit fullscreen mode

📚 More info

Discussion (0)