Updated GitHub issue and code review templates

Necessary to fix an issue with the issue templates since GitHub no longer respects the `.github/ISSUE_TEMPLATE.md` file so am now using the `ISSUE_TEMPLATE` folder with additional links to community and security information. Only a single issue template is being used to reduce the number of choices people have to make. The code view template was also updated to improve the descriptions.

Milestone: minor
This commit is contained in:
Brooke Kuhlmann
2025-08-08 11:17:37 -06:00
parent 6e1f3e8b5a
commit ec55a93405
4 changed files with 29 additions and 11 deletions

View File

@@ -1,8 +0,0 @@
## Why
<!-- Required. Describe, briefly, why this issue is important. -->
## How
<!-- Optional. List exact steps (numbered) to implement or reproduce behavior. Screen shots/casts are welcome. -->
## Notes
<!-- Optional. Provide additional details (i.e operating system, software version(s), stack dump, etc.) -->

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Community
url: https://alchemists.io/community
about: Please ask questions or discuss specifics here.
- name: Security
url: https://alchemists.io/policies/security
about: Please report security vulnerabilities here.

18
.github/ISSUE_TEMPLATE/issue.md vendored Normal file
View File

@@ -0,0 +1,18 @@
---
name: Issue
title: "Add|Update|Fix|Remove|Refactor "
about: Report an issue. Please use only one of the subject prefixes.
---
<!--
Please focus on well written issues. Context: https://alchemists.io/articles/software_issues.
-->
## Why
<!-- Required. Describe, briefly, why this issue is important. -->
## How
<!-- Optional. List exact steps to implement or reproduce behavior. Screen shots/casts are welcome! -->
## Notes
<!-- Optional. Provide additional details like operating system, software version(s), stack dump, logs, or anything else that would be helpful. -->

View File

@@ -1,8 +1,8 @@
## Overview
<!-- Required. Why is this important/necessary and what is the overarching architecture. -->
<!-- Required. Describe, briefly, why this is necessary and what the overarching architecture is. -->
## Screenshots/Screencasts
<!-- Optional. Provide supporting image/video. -->
<!-- Optional. Provide supporting screen shots/casts. -->
## Details
<!-- Optional. List the key features/highlights as bullet points. -->
<!-- Optional. As bullet points, list related issue(s); major highlights; team callouts; and/or other information that is helpful. -->