Skip to content

Commit

Permalink
📜 Docs: update issue templates (#193)
Browse files Browse the repository at this point in the history
* docs: update issue templates

* docs: format SECURITY.md

* docs: update code of conduct link
  • Loading branch information
tyler-dane authored Dec 15, 2024
1 parent 660df77 commit 26fbf48
Show file tree
Hide file tree
Showing 7 changed files with 89 additions and 61 deletions.
7 changes: 0 additions & 7 deletions .github/ISSUE_TEMPLATE/1-Feature_request.md

This file was deleted.

34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/1-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Feature Request
description: You want something added to the app \U0001F389
labels: [enhancement]
projects: [SwitchbackTech/4]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: input
attributes:
label: Feature Title
description: Provide a short and descriptive title for the feature request.
placeholder: Add Fancy New Thing

- type: textarea
attributes:
label: Feature Description
description: Describe the feature you would like to see added.
placeholder: New Thing should work like this ...

- type: textarea
attributes:
label: Use Case
description: Explain the use case for this feature. How will it benefit users?
placeholder: This'll save users time by ...

- type: textarea
attributes:
label: Additional Context
description: Add any other context or screenshots about the feature request here.
placeholder: Here's where I got this idea ...
40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/2-Bug_report.md

This file was deleted.

48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/2-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Bug Report
description: Report technical issues. \U0001F41E
labels: [bug]
projects: [SwitchbackTech/4]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: dropdown
attributes:
label: Where did this happen?
multiple: true
options:
- Production app
- Local code with an up-to-date main branch

- type: textarea
attributes:
label: Expected Behavior
description: What should have happened?
placeholder: Describe the expected behavior...

- type: textarea
attributes:
label: Current Behavior
description: What went wrong?
placeholder: Describe the current behavior...

- type: textarea
attributes:
label: Steps to Reproduce
description: Include a step-by-step guide, along with any stack traces, screenshots, or screen recordings.
placeholder: "1.\n\n2.\n\n3.\n\n4."

- type: textarea
attributes:
label: Possible Solution
description: Suggest a reason for the bug or how to fix it.
placeholder: If you already know how we could solve this, describe it here...

- type: textarea
attributes:
label: Context
description: How has this issue affected users? What are they trying to accomplish?
placeholder: Describe the context...
7 changes: 0 additions & 7 deletions .github/ISSUE_TEMPLATE/3-DevOps.md

This file was deleted.

2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Code of Conduct 🤝

The Compass Code of Conduct is available on the official doc:
[https://docs.compasscalendar.com/docs/CodeOfConduct](https://docs.compasscalendar.com/docs/CodeOfConduct)
[https://docs.compasscalendar.com/docs/code-of-conduct](https://docs.compasscalendar.com/docs/code-of-conduct)
12 changes: 6 additions & 6 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

## Reporting a Vulnerability

If you discover a security vulnerability in this project, please send an email to **tyler@switchback.tech** with the following details:
If you discover a security vulnerability in this project, please send an email to **tyler@switchback.tech** with the following details:

- A description of the vulnerability
- Steps to reproduce (if applicable)
- Any relevant logs, screenshots, or details that can help in identifying the issue
- A description of the vulnerability
- Steps to reproduce (if applicable)
- Any relevant logs, screenshots, or details that can help in identifying the issue

**Please do not disclose the vulnerability publicly until it has been addressed.**
**Please do not disclose the vulnerability publicly until it has been addressed.**

I will make every effort to respond within 48 hours and provide a timeline for a fix. Thank you for helping to keep this project secure!
I will make every effort to respond within 48 hours and provide a timeline for a fix. Thank you for helping to keep this project secure!

0 comments on commit 26fbf48

Please sign in to comment.