Skip to content

feat: Add GitHub issue templates to enhance contribution workflow #200

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

Open
wants to merge 1 commit into
base: development
Choose a base branch
from

Conversation

Programmer-RD-AI
Copy link
Contributor

Purpose

This PR introduces standardized GitHub issue templates to streamline issue tracking, improve the quality of submissions, and reduce maintenance overhead. It addresses the need for structured communication between contributors and maintainers.

Goals

  • Standardize bug reports, feature requests, and documentation updates.
  • Reduce back-and-forth by ensuring contributors provide essential details upfront.
  • Improve triaging efficiency and encourage community contributions.

Approach

  • Added bug_report.md: Guides users to include steps to reproduce, expected vs. actual behavior, and environment details.
  • Added feature_request.md: Standardizes proposal formatting (description, rationale, alternatives).
  • Added documentation.md: Simplifies reporting gaps, typos, or improvement ideas.
  • Configured config.yml: Sets template visibility and validation rules.

Checklist

  • This PR doesn’t commit any secrets.
  • I’ve read the project’s development best practices.
  • Code/style aligns with project guidelines.
  • Self-reviewed and documented unclear sections.
  • Updated relevant documentation.

Related PRs

N/A (This is the first PR for issue templates.)

…ests, and documentation

This commit introduces standardized GitHub issue templates to streamline contributions and issue tracking.

- Added `bug_report.md` template to guide users in submitting detailed bug reports.
- Added `feature_request.md` template to standardize feature proposals.
- Added `documentation.md` template for reporting documentation gaps or improvements.
- Included `config.yml` to configure issue template settings.

These templates improve issue quality, reduce back-and-forth, and ensure consistency in how users and contributors report problems, suggest features, or request documentation updates.
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

Successfully merging this pull request may close these issues.

1 participant