Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need an issue template #32

Open
ChristopherHarwell opened this issue Feb 25, 2024 · 0 comments
Open

Need an issue template #32

ChristopherHarwell opened this issue Feb 25, 2024 · 0 comments

Comments

@ChristopherHarwell
Copy link
Contributor

ChristopherHarwell commented Feb 25, 2024

Since there is currently not an issue template, I propose adding some variation of this issue template so that as a user when I have an issue, I can fill in the values for an issue to provide as much details to the maintainers as possible to resolve said issue. An example of a good issue using this template is this issue #33

---
name: Bug report / Feature request
about: Create a report to help us improve or suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

### Prerequisites

* [ ] Have you checked that your issue does not already exist?

### Description

[Description of the issue or feature request]

### Steps to Reproduce

[If reporting a bug, outline the steps to reproduce or link to a minimal repro]

1. [First Step]
2. [Second Step]
3. [and so on...]

**Expected behavior:** [What you expect to happen]

**Actual behavior:** [What actually happens]

### Environment

- OS: [Please specify here]
- Node Version: [Please specify here]
- PNPM Version: [Please specify here]

### Additional Context

[Add any other context about the problem here. If applicable, add screenshots to help explain.]

This template starts with some YAML front matter to integrate with GitHub's issue template chooser. It distinguishes between a bug report and a feature request, but you can create separate templates for these if preferred.

  • Prerequisites check encourages users to search for existing issues first.
  • Description section provides a clear area for the user to describe the issue or feature request.
  • Steps to Reproduce is essential for bug reports, guiding the reporter to provide a clear, step-by-step description of how to trigger the bug.
  • Expected vs. Actual behavior clearly delineates the difference between what was expected and what the issue actually is.
  • Environment fields specifically ask for the OS, Node version, and PNPM version, which are critical for debugging environment-specific issues.
  • Additional Context allows for any other relevant information, including screenshots.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant