chore: Add GitHub templates (#1)

This commit is contained in:
Eric Tuvesson
2023-09-06 16:27:19 +02:00
committed by GitHub
parent 53f0d6320e
commit aa0ff4e49d
4 changed files with 84 additions and 0 deletions

38
.github/ISSUE_TEMPLATE/1.Bug_report.md vendored Normal file
View File

@@ -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.

View File

@@ -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.

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -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.

15
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -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.