From bef39f807d1937b8e1b2d3a334809a5e4d62e791 Mon Sep 17 00:00:00 2001 From: timothycarambat Date: Tue, 9 Jan 2024 14:14:09 -0800 Subject: [PATCH 1/3] Setup issue templates Allow ability to include blank issue resolves #557 todo: PR template --- .github/ISSUE_TEMPLATE/01_bug.yml | 41 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/02_feature.yml | 18 +++++++++ .github/ISSUE_TEMPLATE/03_documentation.yml | 12 ++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++++ .github/workflows/build-and-push-image.yaml | 1 + 5 files changed, 80 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 diff --git a/.github/ISSUE_TEMPLATE/01_bug.yml b/.github/ISSUE_TEMPLATE/01_bug.yml new file mode 100644 index 00000000000..157477b3d0d --- /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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/02_feature.yml b/.github/ISSUE_TEMPLATE/02_feature.yml new file mode 100644 index 00000000000..9e0fcae3f70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_feature.yml @@ -0,0 +1,18 @@ +name: 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/03_documentation.yml b/.github/ISSUE_TEMPLATE/03_documentation.yml new file mode 100644 index 00000000000..c5c490740ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03_documentation.yml @@ -0,0 +1,12 @@ +name: Documentation improvement +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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..38abca2d496 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Discord Community Support + url: https://discord.gg/6UyHPeGZAC + about: Please ask and answer questions here. + - name: E-mail the team + url: "mailto:team@mintplexlabs.com" + about: Contact the core-team about a question. \ No newline at end of file diff --git a/.github/workflows/build-and-push-image.yaml b/.github/workflows/build-and-push-image.yaml index b8ac6348f9d..f3100842f55 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: From e1e8550834d098d10162f241021de41b810d1df6 Mon Sep 17 00:00:00 2001 From: timothycarambat Date: Tue, 9 Jan 2024 14:24:02 -0800 Subject: [PATCH 2/3] update templates + add PR template --- .github/ISSUE_TEMPLATE/01_bug.yml | 2 +- .github/ISSUE_TEMPLATE/02_feature.yml | 2 +- .github/ISSUE_TEMPLATE/03_documentation.yml | 3 +- .github/ISSUE_TEMPLATE/config.yml | 6 ++-- pull_request_template.md | 36 +++++++++++++++++++++ 5 files changed, 43 insertions(+), 6 deletions(-) create mode 100644 pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/01_bug.yml b/.github/ISSUE_TEMPLATE/01_bug.yml index 157477b3d0d..4c9587f5a26 100644 --- a/.github/ISSUE_TEMPLATE/01_bug.yml +++ b/.github/ISSUE_TEMPLATE/01_bug.yml @@ -1,4 +1,4 @@ -name: Bug Report +name: 🐛 Bug Report description: File a bug report for AnythingLLM title: "[BUG]: " labels: [possible-bug] diff --git a/.github/ISSUE_TEMPLATE/02_feature.yml b/.github/ISSUE_TEMPLATE/02_feature.yml index 9e0fcae3f70..e770f2b07a0 100644 --- a/.github/ISSUE_TEMPLATE/02_feature.yml +++ b/.github/ISSUE_TEMPLATE/02_feature.yml @@ -1,4 +1,4 @@ -name: Feature suggestion +name: ✨ New Feature suggestion description: Suggest a new feature for AnythingLLM! title: "[FEAT]: " labels: [enhancement, feature-request] diff --git a/.github/ISSUE_TEMPLATE/03_documentation.yml b/.github/ISSUE_TEMPLATE/03_documentation.yml index c5c490740ee..001965e3e89 100644 --- a/.github/ISSUE_TEMPLATE/03_documentation.yml +++ b/.github/ISSUE_TEMPLATE/03_documentation.yml @@ -1,4 +1,5 @@ -name: Documentation improvement +name: 📚 Documentation improvement +title: "[DOCS]: " description: Report an issue or problem with the documentation. labels: [documentation] diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 38abca2d496..49e43cbbe72 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ blank_issues_enabled: true contact_links: - - name: Discord Community Support + - name: 🧑‍🤝‍🧑 Community Discord url: https://discord.gg/6UyHPeGZAC - about: Please ask and answer questions here. - - name: E-mail the team + 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. \ No newline at end of file diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 00000000000..837fd1fc5b7 --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,36 @@ + + ### Pull Request Type + + + +- [ ] ✨ feat +- [ ] 🐛 fix +- [ ] ♻️ refactor +- [ ] 💄 style +- [ ] 🔨 chore +- [ ] 📝 docs + +### Relevant Issues + + + +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 + + + +- [ ] 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 \ No newline at end of file From 2f3d92355d416b60b3a785443fdbfcdf30e9b210 Mon Sep 17 00:00:00 2001 From: timothycarambat Date: Tue, 9 Jan 2024 14:25:07 -0800 Subject: [PATCH 3/3] newlines --- .github/ISSUE_TEMPLATE/01_bug.yml | 2 +- .github/ISSUE_TEMPLATE/02_feature.yml | 2 +- .github/ISSUE_TEMPLATE/03_documentation.yml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 2 +- pull_request_template.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/01_bug.yml b/.github/ISSUE_TEMPLATE/01_bug.yml index 4c9587f5a26..043c7852362 100644 --- a/.github/ISSUE_TEMPLATE/01_bug.yml +++ b/.github/ISSUE_TEMPLATE/01_bug.yml @@ -38,4 +38,4 @@ body: 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 \ No newline at end of file + required: false diff --git a/.github/ISSUE_TEMPLATE/02_feature.yml b/.github/ISSUE_TEMPLATE/02_feature.yml index e770f2b07a0..7ca0d0c9246 100644 --- a/.github/ISSUE_TEMPLATE/02_feature.yml +++ b/.github/ISSUE_TEMPLATE/02_feature.yml @@ -15,4 +15,4 @@ body: description: | Describe the feature and why it would be useful to your use-case as well as others. validations: - required: true \ No newline at end of file + required: true diff --git a/.github/ISSUE_TEMPLATE/03_documentation.yml b/.github/ISSUE_TEMPLATE/03_documentation.yml index 001965e3e89..55800856c31 100644 --- a/.github/ISSUE_TEMPLATE/03_documentation.yml +++ b/.github/ISSUE_TEMPLATE/03_documentation.yml @@ -10,4 +10,4 @@ body: label: Description description: Describe the issue with the documentation that is giving you trouble or causing confusion. validations: - required: true \ No newline at end of file + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 49e43cbbe72..ebf87d2748b 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -5,4 +5,4 @@ contact_links: 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. \ No newline at end of file + about: Contact the core-team about a question. diff --git a/pull_request_template.md b/pull_request_template.md index 837fd1fc5b7..1167880b166 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -33,4 +33,4 @@ Add any other context about the Pull Request here that was not captured above. - [ ] 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 \ No newline at end of file +- [ ] Docker build succeeds locally