feat: update issue templates for better clarity

This commit is contained in:
Prad Nukala 2024-10-04 00:02:52 -04:00
parent ac2f65844c
commit f95fa2c906
3 changed files with 62 additions and 23 deletions

View File

@ -1,7 +1,7 @@
name: Bug Report name: Bug Report
description: File a bug report. description: File a bug report.
title: "ERROR: " title: "ERROR: "
labels: ["Bug", "Triage"] labels: ["BUG", "Triage"]
projects: ["onsonr/39"] projects: ["onsonr/39"]
body: body:
- type: textarea - type: textarea

View File

@ -1,42 +1,40 @@
name: Default Todo name: Tracking issue
description: Break down feature requirements into tasks. description: Use this template for tracking new features.
title: "Name of the new task" title: "(v0.6): FEATURE NAME"
labels: ["TODO"] labels: ["OKR"]
projects: ["onsonr/37"]
body: body:
- type: checkboxes - type: checkboxes
attributes: attributes:
label: Is this associated with a tracking issue? label: Is this associated with a milestone?
description: This is a implementation issue for coompletion of a task for a Objective. description: This is a tracking issue for tracking a new feature for a given milestone.
options: options:
- label: I have confirmed this is associated with a tracking issue. - label: I have confirmed this is an OKR tracking issue
required: true required: true
- type: textarea - type: textarea
attributes: attributes:
label: Description label: Objective
description: Write a "prompt" for the task. description: Explain the objective of the feature.
validations: validations:
required: false required: false
- type: textarea - type: textarea
attributes: attributes:
label: Associated Files label: Task List
description: | description: |
- [proto/did/v1/state.proto](https://github.com/onsonr/sonr/blob/develop/proto/did/v1/state.proto) Break down of tasks to complete the objective.
- [proto/did/v1/tx.proto](https://github.com/onsonr/sonr/blob/develop/proto/did/v1/tx.proto)
render: markdown
value: | value: |
- [proto/did/v1/state.proto](https://github.com/onsonr/sonr/blob/develop/proto/did/v1/state.proto) - [ ] Task 1
- [proto/did/v1/tx.proto](https://github.com/onsonr/sonr/blob/develop/proto/did/v1/tx.proto) - [ ] Task 2
- [ ] Task 3
render: markdown
validations: validations:
required: false required: false
- type: textarea - type: textarea
attributes: attributes:
label: References label: Additional Resources
description: | description: |
- [Cosmos ORM Docs](https://github.com/cosmos/orm) Links? References? Anything that will give us more context about the issue you are encountering!
- [DID Document Spec](https://docs.cosmos.network)
render: markdown Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
value: |
- [Cosmos ORM Docs](https://github.com/cosmos/orm)
- [DID Document Spec](https://docs.cosmos.network)
validations: validations:
required: false required: false

View File

@ -0,0 +1,41 @@
name: Default Todo
description: Break down feature requirements into tasks.
title: "Name of the new task"
labels: ["TODO"]
projects: ["onsonr/37"]
body:
- type: checkboxes
attributes:
label: Is this associated with a tracking issue?
description: This is a implementation issue for coompletion of a task for a Objective.
options:
- label: I have confirmed this is associated with a tracking issue.
required: true
- type: textarea
attributes:
label: Description
description: The expected deliverable of the task.
validations:
required: false
- type: textarea
attributes:
label: Associated Files
description: |
These files will be modified by this task.
render: markdown
value: |
- [proto/did/v1/state.proto](https://github.com/onsonr/sonr/blob/develop/proto/did/v1/state.proto)
- [proto/did/v1/tx.proto](https://github.com/onsonr/sonr/blob/develop/proto/did/v1/tx.proto)
validations:
required: false
- type: textarea
attributes:
label: References
description: |
Use these documents to help you complete the task.
render: markdown
value: |
- [Cosmos ORM Docs](https://github.com/cosmos/orm)
- [DID Document Spec](https://docs.cosmos.network)
validations:
required: false