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

Adding GH Issue Templates #97

Merged
merged 8 commits into from
Sep 3, 2024
Merged

Adding GH Issue Templates #97

merged 8 commits into from
Sep 3, 2024

Conversation

adamamer20
Copy link
Collaborator

This PR introduces standardized GitHub issue templates for bug reports and feature requests. These templates will help streamline our issue management process by ensuring that contributors provide consistent and comprehensive information when reporting bugs or suggesting new features.

  1. Added a bug report template (bug_report.yml)

    • Includes fields for description, steps to reproduce, expected behavior, actual behavior, and environment information
    • Uses emojis for improved readability and user engagement
  2. Added a feature request template (feature_request.yml)

    • Includes fields for problem description, proposed solution, alternatives considered, and priority
    • Also uses emojis for consistency and visual appeal
  3. Both templates are configured to automatically add appropriate labels ("bug" or "feature" + "triage")

@adamamer20 adamamer20 linked an issue Sep 2, 2024 that may be closed by this pull request
@adamamer20 adamamer20 self-assigned this Sep 2, 2024
@adamamer20 adamamer20 added enhancement Improvements to existing features or performance. maintenance General maintenance tasks, code refactoring, or cleanup. labels Sep 2, 2024
@EwoutH
Copy link
Member

EwoutH commented Sep 2, 2024

Great idea, but maybe these are a bit too detailed/restrictive?

@adamamer20
Copy link
Collaborator Author

adamamer20 commented Sep 2, 2024

Great idea, but maybe these are a bit too detailed/restrictive?

Yes, the idea was to use them with #94. What do you recommend? removing required=True from the section or completely removing some sections?

@EwoutH
Copy link
Member

EwoutH commented Sep 2, 2024

The templates we have at Mesa itself only give some suggested headers, not fixed boxes. You can change and modify them. For now I personally would go that direction.

Copy link
Member

@EwoutH EwoutH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still find them a bit verbose, but it will probably help structure for new contributors.

.github/ISSUE_TEMPLATE/feature_request.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
@adamamer20 adamamer20 merged commit 9c2fd94 into main Sep 3, 2024
5 checks passed
@adamamer20 adamamer20 deleted the 96-adding-gh-issue-templates branch September 3, 2024 09:24
@adamamer20 adamamer20 linked an issue Oct 1, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements to existing features or performance. maintenance General maintenance tasks, code refactoring, or cleanup.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding GH issue Templates Create a template for issues
2 participants