Skip to content

Commit

Permalink
chore(templates): add github template for issues and pull request (ru…
Browse files Browse the repository at this point in the history
…n-llama#532)

chore(templates): add github template for issues and pull request
  • Loading branch information
EmanuelCampos authored Sep 23, 2023
1 parent 2c4a6ec commit 0e13be1
Show file tree
Hide file tree
Showing 6 changed files with 160 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: LlamaHub Website
url: https://llamahub.ai/
about: Please review/search the website before posting an issue.
- name: LlamaIndex Documentation
url: https://gpt-index.readthedocs.io/en/latest/index.html
about: Please review/search the latest documentation before posting an issue.
- name: LlamaIndex Community Support
url: https://discord.gg/dGcwcsnxhU
about: Please direct any questions on the usage of LlamaIndex to the discord. Feel free to search the discord to find answers to questions as well!
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/docs-form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Documentation Change Request
description: Request a change to the documenation
title: "[Documentation]: "
labels: ["documentation", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this documenation request!
Please complete the following form to help us assist you.
- type: textarea
id: doc-description
attributes:
label: Documentation Issue Description
description: Describe what is missing or broken in the documentation.
validations:
required: true
- type: input
id: docs-link
attributes:
label: Documenation Link
description: Please link to the section of documenation that is broken or missing information.
validations:
required: true
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature Request
description: Request a new feature
title: "[Feature Request]: "
labels: ["enhancement", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
Please complete the following form to help us assist you.
- type: textarea
id: feature-description
attributes:
label: Feature Description
description: Describe the feature you are requesting. Try to reference existing implemenations/papers/examples when possible.
validations:
required: true
- type: textarea
id: why-feature
attributes:
label: Reason
description: What is stopping LlamaIndex from supporting this feature today? What existing apporaches have not worked for you?
validations:
required: false
- type: textarea
id: value-add
attributes:
label: Value of Feature
description: Why is this feature valuable?
validations:
required: false
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/issue-form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Please complete the following form to help us assist you.
- type: textarea
id: what-happened
attributes:
label: Bug Description
description: What happened?
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of llama-index are you using?
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Which steps should someone take to run into the same error?
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant Logs/Tracbacks
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/question-form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: General Question
description: Ask a question
title: "[Question]: "
labels: ["question"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this question form!
Please complete the following form to help us assist you.
- type: checkboxes
id: pre-question
attributes:
label: Question Validation
description: By submitting this issue, you agree that you've previously search our [documentation](https://gpt-index.readthedocs.io/en/latest/index.html) and [discord](https://discord.gg/dGcwcsnxhU) and did not find a proper answer to your question.
options:
- label: I have searched both the documentation and discord for an answer.
required: true
- type: textarea
id: question
attributes:
label: Question
description: Ask your question here!
validations:
required: true
32 changes: 32 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

## Type of Change

Please delete options that are not relevant.

- [ ] New Loader/Tool
- [ ] Bug fix / Smaller change
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

# How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

- [ ] Added new unit/integration tests
- [ ] Added new notebook (that tests end-to-end)
- [ ] I stared at the code and made sure it makes sense

# Suggested Checklist:

- [ ] I have added a library.json file if a new loader/tool was added
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes

0 comments on commit 0e13be1

Please sign in to comment.