From aa0ff4e49df006b65c7f13f2fe5a5a97be50c85d Mon Sep 17 00:00:00 2001 From: Eric Tuvesson Date: Wed, 6 Sep 2023 16:27:19 +0200 Subject: [PATCH] chore: Add GitHub templates (#1) --- .github/ISSUE_TEMPLATE/1.Bug_report.md | 38 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/2.Improve_docs.md | 23 ++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++++ .github/PULL_REQUEST_TEMPLATE.md | 15 ++++++++++ 4 files changed, 84 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1.Bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/2.Improve_docs.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/1.Bug_report.md b/.github/ISSUE_TEMPLATE/1.Bug_report.md new file mode 100644 index 0000000..d910a14 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1.Bug_report.md @@ -0,0 +1,38 @@ +--- +name: Documentation Bug report +about: Create a bug report for the documentation site. +labels: bug +--- + +# Documentation Bug report + +## Describe the bug + +A clear and concise description of what the bug is. + +## To Reproduce + +Steps to reproduce the behavior, please provide code snippets or a repository: + +1. Go to '…' +2. Click on '…' +3. Scroll down to '…' +4. See error + +## Expected behavior + +A clear and concise description of what you expected to happen. + +## Screenshots + +If applicable, add screenshots to help explain your problem. + +## System information + +- OS: [e.g. macOS, Windows] +- Browser (if applies) [e.g. chrome, safari] +- Version of Node.js: [e.g. 10.10.0] + +## Additional context + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/2.Improve_docs.md b/.github/ISSUE_TEMPLATE/2.Improve_docs.md new file mode 100644 index 0000000..97e850c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2.Improve_docs.md @@ -0,0 +1,23 @@ +--- +name: Improve documentation +about: Suggest an improvement to our documentation +labels: documentation +--- + +# Improve documentation + +## Link + +Add a link to the page which needs improvement (if relevant) + +## Describe the problem + +Is the documentation missing? Or is it confusing? Why is it confusing? + +## Describe the improvement + +A clear and concise description of the improvement. + +## Additional context + +Add any other context or screenshots that help clarify your question. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..cfd0915 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Feature request + url: https://github.com/noodlapp/noodl-docs/discussions/categories/feature-requests + about: Request a new feature or example. + - name: Ask a question + url: https://github.com/noodlapp/noodl-docs/discussions/categories/q-a + about: Ask questions and discuss with other community members. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..878f7c4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +## What kind of change does this PR introduce? + +Bug fix, feature, docs update, ... + +## What is the current behavior? + +Please link any relevant issues here. + +## What is the new behavior? + +Feel free to include screenshots if it includes visual changes. + +## Additional context + +Add any other context or screenshots.