chore: Added GitHub issue form templates (#8119)
This commit is contained in:
Siddharth Mishra
GitHub
parent
57bdbdc0f9
commit
97a330c4e9
22
.github/ISSUE_TEMPLATE/----feature-request.md
vendored
22
.github/ISSUE_TEMPLATE/----feature-request.md
vendored
|
|
@ -1,22 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F6E0️ Feature request"
|
|
||||||
about: Suggest an idea to improve appsmith
|
|
||||||
title: "[Feature]"
|
|
||||||
labels: Enhancement
|
|
||||||
assignees: Nikhil-Nandagopal
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Summary
|
|
||||||
|
|
||||||
One paragraph description of the feature.
|
|
||||||
|
|
||||||
## Motivation
|
|
||||||
|
|
||||||
Why should this be worked on? What problems or use cases does it solve or
|
|
||||||
improve?
|
|
||||||
|
|
||||||
## Additional Context
|
|
||||||
|
|
||||||
Any other context or screenshots or API request payload/responses that you
|
|
||||||
pertain to the feature.
|
|
||||||
28
.github/ISSUE_TEMPLATE/---bug-report.md
vendored
28
.github/ISSUE_TEMPLATE/---bug-report.md
vendored
|
|
@ -1,28 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F41B Bug report"
|
|
||||||
about: Create a bug report to help us improve appsmith
|
|
||||||
title: "[Bug]"
|
|
||||||
labels: Bug, Needs Triaging
|
|
||||||
assignees: Nikhil-Nandagopal
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
[What happened]
|
|
||||||
|
|
||||||
### Steps to reproduce the behaviour:
|
|
||||||
|
|
||||||
Add steps to reproduce this behaviour, include console / network logs & screenshots
|
|
||||||
|
|
||||||
1. Go to '...'
|
|
||||||
2. Click on '....'
|
|
||||||
3. Scroll down to '....'
|
|
||||||
4. See error
|
|
||||||
|
|
||||||
### Important Details
|
|
||||||
|
|
||||||
- Version: [Cloud / Self-Hosted vx.x]
|
|
||||||
- OS: [e.g.MacOSX]
|
|
||||||
- Browser [e.g. chrome, safari]
|
|
||||||
- Environment [production, release, deploy preview]
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F4D6 Documentation Improvement"
|
|
||||||
about: Suggest improvements to our documentation
|
|
||||||
title: "[Docs] "
|
|
||||||
labels: Documentation
|
|
||||||
assignees: Nikhil-Nandagopal
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
42
.github/ISSUE_TEMPLATE/---epic.md
vendored
42
.github/ISSUE_TEMPLATE/---epic.md
vendored
|
|
@ -1,42 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F4D3 Epic"
|
|
||||||
about: A large planned scope of work for the quarter
|
|
||||||
title: "[Epic]"
|
|
||||||
labels: Epic, Product Note
|
|
||||||
assignees: Nikhil-Nandagopal
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Objective
|
|
||||||
Here you fill in the objective of the product/feature that you are writing about.
|
|
||||||
|
|
||||||
# Success Metrics
|
|
||||||
List of all metrics you are tracking and the desired goal.
|
|
||||||
| Goal | Metric |
|
|
||||||
| ------------- | ------------- |
|
|
||||||
| e.g. Simplify user experience | Customer satisfaction score increases |
|
|
||||||
| e.g. Simplify onboarding flow | Decrease churn rate down to 30% |
|
|
||||||
|
|
||||||
# Requirements
|
|
||||||
| Requirement | User Story | Importance | Notes |
|
|
||||||
| ------------- | ------------- | ------------- | ------------- |
|
|
||||||
| e.g. Must be mobile responsive | e.g. as a user, I want to be able to access the platform via mobile phone | High, Low or Medium | Content Cell |
|
|
||||||
| e.g. The user should be able to leave a comment | e.g as a user, I want to be able to communicate with the other members on the canvas | High, Low or Medium | Content Cell |
|
|
||||||
|
|
||||||
# Out of Scope
|
|
||||||
List the things that are out of cope or might be revisited after the first release.
|
|
||||||
- Item 1
|
|
||||||
- Item 2
|
|
||||||
- Item 3
|
|
||||||
|
|
||||||
# Developer Handoff Document in Figma
|
|
||||||
Link to the developer Handoff Document:
|
|
||||||
|
|
||||||
# RACI matrix
|
|
||||||
|
|
||||||
| Label | Value |
|
|
||||||
| ------------- | ------------- |
|
|
||||||
| Responsible | |
|
|
||||||
| Accountable | |
|
|
||||||
| Consulted | @Nikhil-Nandagopal, @mohanarpit, @areyabhishek|
|
|
||||||
| Informed | |
|
|
||||||
12
.github/ISSUE_TEMPLATE/---task.md
vendored
12
.github/ISSUE_TEMPLATE/---task.md
vendored
|
|
@ -1,12 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F4DD Task"
|
|
||||||
about: Create a task for the team to work on
|
|
||||||
title: "[Task] "
|
|
||||||
labels: Task
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## SubTasks
|
|
||||||
- Sub Task1
|
|
||||||
- Sub Task2
|
|
||||||
66
.github/ISSUE_TEMPLATE/--bug-report.yaml
vendored
Normal file
66
.github/ISSUE_TEMPLATE/--bug-report.yaml
vendored
Normal file
|
|
@ -0,0 +1,66 @@
|
||||||
|
name: 🐞 Bug report
|
||||||
|
description: Create a bug report to help us improve Appsmith
|
||||||
|
title: "[Bug]: "
|
||||||
|
labels: [Bug, Needs Triaging]
|
||||||
|
assignees:
|
||||||
|
- Nikhil-Nandagopal
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to fill out this bug report! Please fill the form in English!
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing issue for this?
|
||||||
|
description: Please search to see if an issue already exists for the bug you encountered.
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Current Behavior
|
||||||
|
description: A concise description of what you're experiencing.
|
||||||
|
placeholder: |
|
||||||
|
When I do <X>, <Y> happens and I see the error message attached below:
|
||||||
|
```...```
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Expected Behavior
|
||||||
|
description: A concise description of what you expected to happen.
|
||||||
|
placeholder: When I do <X>, <Z> should happen instead.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Steps To Reproduce
|
||||||
|
description: Add steps to reproduce this behaviour, include console / network logs & screenshots
|
||||||
|
placeholder: |
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
render: markdown
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Environment
|
||||||
|
description: |
|
||||||
|
Enter the Environment Details:
|
||||||
|
value: |
|
||||||
|
- Version: [Cloud / Self-Hosted vx.x]
|
||||||
|
- OS: [e.g.MacOSX]
|
||||||
|
- Browser [e.g. chrome, safari]
|
||||||
|
- Environment [production, release, deploy preview]
|
||||||
|
render: markdown
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Anything else?
|
||||||
|
description: |
|
||||||
|
Links? References? Anything that will give us more context about the issue you are encountering!
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
43
.github/ISSUE_TEMPLATE/--documentation-improvement.yaml
vendored
Normal file
43
.github/ISSUE_TEMPLATE/--documentation-improvement.yaml
vendored
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
name: 📖 Documentation Improvement
|
||||||
|
description: Suggest improvements to our documentation
|
||||||
|
title: "[Docs]: "
|
||||||
|
labels: [Documentation]
|
||||||
|
assignees:
|
||||||
|
- Nikhil-Nandagopal
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to fill out this documentation improvement request!
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing issue for this?
|
||||||
|
description: Please search to see if an issue realated to this already exists.
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Documentation Link
|
||||||
|
description: Add a link to the page which needs improvement (if relevant)
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Describe the problem
|
||||||
|
description: Is the documentation missing? Or is it confusing? Why is it confusing?
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Describe the improvement
|
||||||
|
description: A clear and concise description of the improvement.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Anything else?
|
||||||
|
description: |
|
||||||
|
Links? References? Anything that will give us more context about the issue you are encountering!
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
82
.github/ISSUE_TEMPLATE/--epic.yaml
vendored
Normal file
82
.github/ISSUE_TEMPLATE/--epic.yaml
vendored
Normal file
|
|
@ -0,0 +1,82 @@
|
||||||
|
name: 📓 Epic
|
||||||
|
description: A large planned scope of work for the quarter
|
||||||
|
title: "[Epic]: "
|
||||||
|
labels: [Epic, Product Note]
|
||||||
|
assignees:
|
||||||
|
- Nikhil-Nandagopal
|
||||||
|
body:
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing issue for this?
|
||||||
|
description: Please search to see if an issue already exists.
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Objective
|
||||||
|
description: Here you fill in the objective of the product/feature that you are writing about.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Success Metrics
|
||||||
|
description: List of all metrics you are tracking and the desired goal.
|
||||||
|
value: |
|
||||||
|
| Goal | Metric |
|
||||||
|
| ------------- | ------------- |
|
||||||
|
| e.g. Simplify user experience | Customer satisfaction score increases |
|
||||||
|
| e.g. Simplify onboarding flow | Decrease churn rate down to 30% |
|
||||||
|
render: markdown
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Requirements
|
||||||
|
value: |
|
||||||
|
| Requirement | User Story | Importance | Notes |
|
||||||
|
| ------------- | ------------- | ------------- | ------------- |
|
||||||
|
| e.g. Must be mobile responsive | e.g. as a user, I want to be able to access the platform via mobile phone | High, Low or Medium | Content Cell |
|
||||||
|
| e.g. The user should be able to leave a comment | e.g as a user, I want to be able to communicate with the other members on the canvas | High, Low or Medium | Content Cell |
|
||||||
|
render: markdown
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Out of Scope
|
||||||
|
description: |
|
||||||
|
List the things that are out of cope or might be revisited after the first release.
|
||||||
|
placeholder: |
|
||||||
|
- Item 1
|
||||||
|
- Item 2
|
||||||
|
- Item 3
|
||||||
|
render: markdown
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Developer Handoff Document in Figma
|
||||||
|
description: Link to the developer Handoff Document.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: RACI matrix
|
||||||
|
description: Please fill the table below.
|
||||||
|
value: |
|
||||||
|
| Label | Value |
|
||||||
|
| ------------- | ------------- |
|
||||||
|
| Responsible | |
|
||||||
|
| Accountable | |
|
||||||
|
| Consulted | @Nikhil-Nandagopal, @mohanarpit, @areyabhishek|
|
||||||
|
| Informed | |
|
||||||
|
render: markdown
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Anything else?
|
||||||
|
description: |
|
||||||
|
Links? References? Anything that will give us more context about this!
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
36
.github/ISSUE_TEMPLATE/--feature-request.yaml
vendored
Normal file
36
.github/ISSUE_TEMPLATE/--feature-request.yaml
vendored
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
name: 🛠️ Feature request
|
||||||
|
description: Suggest an idea to improve appsmith
|
||||||
|
title: "[Feature]: "
|
||||||
|
labels: [Enhancement]
|
||||||
|
assignees:
|
||||||
|
- Nikhil-Nandagopal
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to request a feature for Appsmith!
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing issue for this?
|
||||||
|
description: Please search to see if an issue related to this feature request already exists.
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Summary
|
||||||
|
description: One paragraph description of the feature.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Why should this be worked on? What problems or use cases does it solve or improve?
|
||||||
|
description: A concise description of the problem you are facing or the motivation behind this feature request.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Anything else?
|
||||||
|
description: Any other context or screenshots or API request payload/responses that you pertain to the feature.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
20
.github/ISSUE_TEMPLATE/--task.yaml
vendored
Normal file
20
.github/ISSUE_TEMPLATE/--task.yaml
vendored
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
name: 📝 Task
|
||||||
|
description: Create a task for the team to work on
|
||||||
|
title: "[Task]: "
|
||||||
|
labels: [Task]
|
||||||
|
body:
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing issue for this?
|
||||||
|
description: Please search to see if an issue related to this already exists.
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: SubTasks
|
||||||
|
placeholder: |
|
||||||
|
- Sub Task 1
|
||||||
|
- Sub Task 2
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
5
.gitignore
vendored
5
.gitignore
vendored
|
|
@ -4,6 +4,11 @@
|
||||||
.env
|
.env
|
||||||
.vscode/*
|
.vscode/*
|
||||||
|
|
||||||
|
# to ignore the node_modeules folder
|
||||||
|
node_modules
|
||||||
|
# to ignore the package-lock.json file
|
||||||
|
package-lock.json
|
||||||
|
|
||||||
# test coverage
|
# test coverage
|
||||||
coverage-summary.json
|
coverage-summary.json
|
||||||
app/client/cypress/locators/Widgets.json
|
app/client/cypress/locators/Widgets.json
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user