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
This commit is contained in:
Timothy Carambat 2024-01-09 14:25:53 -08:00 committed by GitHub
parent 5c3bb4b8cc
commit fd4a230669
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 117 additions and 0 deletions

41
.github/ISSUE_TEMPLATE/01_bug.yml vendored Normal file
View File

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

18
.github/ISSUE_TEMPLATE/02_feature.yml vendored Normal file
View File

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

View File

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

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

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

View File

@ -19,6 +19,7 @@ on:
- 'images/*'
- '.vscode/*'
- '**/.env.example'
- '.github/ISSUE_TEMPLATE/*'
jobs:
push_multi_platform_to_registries:

36
pull_request_template.md Normal file
View File

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