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

Add issue templates to the Github repository #412

Open
luiscosio opened this issue Jan 19, 2025 · 0 comments
Open

Add issue templates to the Github repository #412

luiscosio opened this issue Jan 19, 2025 · 0 comments

Comments

@luiscosio
Copy link

Title: Add Issue Templates to the Repository

Description:
We need to set up standardized issue templates in our repository to ensure that bug reports, feature requests, and other feedback are submitted in a clear, consistent format. This will streamline our development workflow and make it easier to track and resolve issues.

Why This Is Important:

  • Encourages contributors to provide all necessary information when creating issues.
  • Helps maintainers triage issues more efficiently.
  • Improves overall project organization.

Proposed Solution:

  1. Create a new folder: .github/ISSUE_TEMPLATE/.
  2. Add separate Markdown files for each template (e.g., bug_report.md, feature_request.md, etc.).
  3. Include prompts for required information in each template (steps to reproduce, expected vs. actual results, screenshots, etc.).
  4. Optionally, add default labels (like bug, enhancement) within each template for auto-labeling.

Resources:

Additional Notes/To-Do:

  • Decide on any custom labels or required sections for each template (severity, environment, version, etc.).
  • Ensure the language and format align with our contribution guidelines.

Acceptance Criteria:

  • A .github/ISSUE_TEMPLATE/ folder is present.
  • At least one bug report template and one feature request template are available.
  • Issues created via these templates provide enough information for quick triaging.
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