From fd4a2306692c8359e19b14b4fb8072276c56a44e Mon Sep 17 00:00:00 2001
From: Timothy Carambat <rambat1010@gmail.com>
Date: Tue, 9 Jan 2024 14:25:53 -0800
Subject: [PATCH] Setup issue and PR templates (#559)
* Setup issue templates
Allow ability to include blank issue
resolves #557
todo: PR template
* update templates + add PR template
* newlines
---
.github/ISSUE_TEMPLATE/01_bug.yml | 41 +++++++++++++++++++++
.github/ISSUE_TEMPLATE/02_feature.yml | 18 +++++++++
.github/ISSUE_TEMPLATE/03_documentation.yml | 13 +++++++
.github/ISSUE_TEMPLATE/config.yml | 8 ++++
.github/workflows/build-and-push-image.yaml | 1 +
pull_request_template.md | 36 ++++++++++++++++++
6 files changed, 117 insertions(+)
create mode 100644 .github/ISSUE_TEMPLATE/01_bug.yml
create mode 100644 .github/ISSUE_TEMPLATE/02_feature.yml
create mode 100644 .github/ISSUE_TEMPLATE/03_documentation.yml
create mode 100644 .github/ISSUE_TEMPLATE/config.yml
create mode 100644 pull_request_template.md
diff --git a/.github/ISSUE_TEMPLATE/01_bug.yml b/.github/ISSUE_TEMPLATE/01_bug.yml
new file mode 100644
index 000000000..043c78523
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/01_bug.yml
@@ -0,0 +1,41 @@
+name: 🐛 Bug Report
+description: File a bug report for AnythingLLM
+title: "[BUG]: "
+labels: [possible-bug]
+body:
+ - type: markdown
+ attributes:
+ value: Use this template to file a bug report for AnythingLLM. Please be as descriptive as possible to allow everyone to replicate and solve your issue.
+
+ - type: dropdown
+ id: runtime
+ attributes:
+ label: How are you running AnythingLLM?
+ description: AnythingLLM can be run in many environments, pick the one that best represents where you encounter the bug.
+ options:
+ - Docker (local)
+ - Docker (remote machine)
+ - Local development
+ - AnythingLLM desktop app
+ - Not listed
+ default: 0
+ validations:
+ required: true
+
+ - type: textarea
+ id: what-happened
+ attributes:
+ label: What happened?
+ description: Also tell us, what did you expect to happen?
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduction
+ attributes:
+ label: Are there known steps to reproduce?
+ description: |
+ Let us know how to reproduce the bug and we may be able to fix it more
+ quickly. This is not required, but it is helpful.
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/02_feature.yml b/.github/ISSUE_TEMPLATE/02_feature.yml
new file mode 100644
index 000000000..7ca0d0c92
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/02_feature.yml
@@ -0,0 +1,18 @@
+name: ✨ New Feature suggestion
+description: Suggest a new feature for AnythingLLM!
+title: "[FEAT]: "
+labels: [enhancement, feature-request]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Share a new idea for a feature or improvement. Be sure to search existing
+ issues first to avoid duplicates.
+ - type: textarea
+ id: description
+ attributes:
+ label: What would you like to see?
+ description: |
+ Describe the feature and why it would be useful to your use-case as well as others.
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/03_documentation.yml b/.github/ISSUE_TEMPLATE/03_documentation.yml
new file mode 100644
index 000000000..55800856c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/03_documentation.yml
@@ -0,0 +1,13 @@
+name: 📚 Documentation improvement
+title: "[DOCS]: "
+description: Report an issue or problem with the documentation.
+labels: [documentation]
+
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ description: Describe the issue with the documentation that is giving you trouble or causing confusion.
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..ebf87d274
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+ - name: 🧑🤝🧑 Community Discord
+ url: https://discord.gg/6UyHPeGZAC
+ about: Interact with the Mintplex Labs community here by asking for help, discussing and more!
+ - name: 📧 E-mail the team
+ url: "mailto:team@mintplexlabs.com"
+ about: Contact the core-team about a question.
diff --git a/.github/workflows/build-and-push-image.yaml b/.github/workflows/build-and-push-image.yaml
index b8ac6348f..f3100842f 100644
--- a/.github/workflows/build-and-push-image.yaml
+++ b/.github/workflows/build-and-push-image.yaml
@@ -19,6 +19,7 @@ on:
- 'images/*'
- '.vscode/*'
- '**/.env.example'
+ - '.github/ISSUE_TEMPLATE/*'
jobs:
push_multi_platform_to_registries:
diff --git a/pull_request_template.md b/pull_request_template.md
new file mode 100644
index 000000000..1167880b1
--- /dev/null
+++ b/pull_request_template.md
@@ -0,0 +1,36 @@
+
+ ### Pull Request Type
+
+<!-- For change type, change [ ] to [x]. -->
+
+- [ ] ✨ feat
+- [ ] 🐛 fix
+- [ ] ♻️ refactor
+- [ ] 💄 style
+- [ ] 🔨 chore
+- [ ] 📝 docs
+
+### Relevant Issues
+
+<!-- Use "resolves #xxx" to auto resolve on merge. Otherwise, please use "connect #xxx" -->
+
+resolves #xxx
+
+
+### What is in this change?
+
+Describe the changes in this PR that are impactful to the repo.
+
+
+### Additional Information
+
+Add any other context about the Pull Request here that was not captured above.
+
+### Developer Validations
+
+<!-- All of the applicable items should be checked. -->
+
+- [ ] I ran `yarn lint` from the root of the repo & committed changes
+- [ ] Relevant documentation has been updated
+- [ ] I have tested my code functionality
+- [ ] Docker build succeeds locally
--
GitLab