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

[QoL] Add Bug and Feature Request template #438

Merged
merged 3 commits into from
Jan 20, 2025
Merged

Conversation

svenvg93
Copy link
Contributor

As this project gets more and more popular there will be more Feature Requests and bug reports. As there is currently no structure for these. This PR add templates for both of them. Which hopefully makes your life a bit easier 😄

Bug Template

  • Add checkbox that the docs has been checked
  • Add checkbos that open and closed issues has been searched for similar problems.
  • Add description field
  • Add Expected Behavior field
  • Add Steps to Reproduce field
  • Add multiple fields to collection information about the installation

Feature Request Template

  • Add checkbos that open and closed requests has been searched for similar requests.
  • Add dropdown to select the section (Charts, Notifications, metrics collection etc)
  • Add description field

Let me know if you want any changes to this, happy to adjust it to your wishes 😄

@henrygd
Copy link
Owner

henrygd commented Jan 18, 2025

Thank you! 🙏

I appreciate this. Recently it's been hard enough to respond to notifications, let alone focus on development. There's only so much time in a day. It would be a huge help if this could streamline things a bit.

I'm going to push the files to a private repo so I can see how it behaves, then I'll merge or tweak it. Thanks!

@svenvg93
Copy link
Contributor Author

svenvg93 commented Jan 19, 2025

Perfect! Let me know If you need anything else 😄 .

If you want I can do the same for the discussions, or add a stale bot for issues that are stale because OP does not response to your questions.

@henrygd henrygd merged commit 90378d0 into henrygd:main Jan 20, 2025
@henrygd
Copy link
Owner

henrygd commented Jan 20, 2025

Merged, thanks! 👍

I combined what you had with some things that other repos are doing, and I think it works pretty nicely now.

A stale bot sounds great if we can set some rules for it. Like don't close an issue if it has a bug or enhancement label. And only close if I was the last one to reply and at least 30 days have passed with no activity. And add a nice message that they're free to reopen the issue if it's not resolved.

I can look into it though, you don't need to do it if you don't want to!

@svenvg93
Copy link
Contributor Author

svenvg93 commented Jan 20, 2025

To give you some idea, this is the one I made for another repro. Feel free to use it and adjust where needed.

  • Only applies to isseus with the bug and qeustion label
  • marks stale after 7 days, and closed after anohter 7 days.
  • Nice message when stale and close.
name: Close Stale Issues

on:
  # Runs daily at 10:00 AM UTC
  schedule:
    - cron: '0 10 * * *'
  # Runs at issue comment
  issue_comment:
    types: [created]

  # Allow manual trigger
  workflow_dispatch:

jobs:
  manage-stale-issues:
    runs-on: ubuntu-latest

    steps:
      - name: Close Stale Issues
        uses: actions/stale@v9
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          
          # Issue-specific configuration
          stale-issue-message: >
            👋 This issue has been automatically marked as stale due to inactivity.
            If this issue is still relevant, please comment to keep it open.
            Without activity, it will be closed in 7 days.
          
          close-issue-message: > 
            🔒 This issue has been automatically closed due to prolonged inactivity.
            Feel free to reopen if the issue is still valid.
          
          # More nuanced staleness criteria
          days-before-issue-stale: 7        # Mark as stale after 7 days of inactivity
          days-before-issue-close: 7         # Close 7 days after being marked stale
          
          # More specific labeling
          stale-issue-label: ':grey_question: no-issue-activity'
          close-issue-label: ':lock: closed-no-issue-activity'
          
          # Refined issue selection, Only issues with both bug and question label
          only-issue-labels: ':bug: bug, :question: question'

# Issues will be closed as "Not Planned" by default. 

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.

2 participants