Skip to content

Commit

Permalink
chore: Added GitHub issue form templates (appsmithorg#8119)
Browse files Browse the repository at this point in the history
  • Loading branch information
Hard-Coder05 authored Oct 11, 2021
1 parent 57bdbdc commit 97a330c
Show file tree
Hide file tree
Showing 11 changed files with 252 additions and 124 deletions.
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/----feature-request.md

This file was deleted.

28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE/---bug-report.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/---documentation-improvement.md

This file was deleted.

42 changes: 0 additions & 42 deletions .github/ISSUE_TEMPLATE/---epic.md

This file was deleted.

12 changes: 0 additions & 12 deletions .github/ISSUE_TEMPLATE/---task.md

This file was deleted.

66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/--bug-report.yaml
Original file line number Diff line number Diff line change
@@ -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 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/--documentation-improvement.yaml
Original file line number Diff line number Diff line change
@@ -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 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/--epic.yaml
Original file line number Diff line number Diff line change
@@ -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 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/--feature-request.yaml
Original file line number Diff line number Diff line change
@@ -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 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/--task.yaml
Original file line number Diff line number Diff line change
@@ -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 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
.env
.vscode/*

# to ignore the node_modeules folder
node_modules
# to ignore the package-lock.json file
package-lock.json

# test coverage
coverage-summary.json
app/client/cypress/locators/Widgets.json

0 comments on commit 97a330c

Please sign in to comment.