Skip to content

Update github templates #699

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update github templates #699

wants to merge 1 commit into from

Conversation

dfaust
Copy link
Member

@dfaust dfaust commented Jul 15, 2025

Updates the GitHub templates to create issues and MRs.

  • Issue templates for: Bug reports, feature requests and documentation issues
  • Adds selections for OS, notify component, etc.
  • Adds more suggestions for details to include in bug reports
  • Reminds contributors to update the change-log
  • Fixes the licenses contributors must agree to

Preview issue creation: https://github.com/dfaust/notify/issues/new/choose

I would also like if somebody would enable the GitHub discussion feature. A link to the discussions is included in the issue creation dialog.

@dfaust dfaust force-pushed the github-templates branch from b645fa3 to c9af9d7 Compare July 16, 2025 10:59
JohnTitor
JohnTitor reviewed Jul 16, 2025
View reviewed changes
.github/PULL_REQUEST_TEMPLATE.md

<!-- After creating this pull request, the test suite will run.
## Changelog
Add an entry to CHANGELOG.md if applicable. Create a new section `## notify (unreleased)` if not already present.
Copy link
Member

Choose a reason for hiding this comment

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

The manual management of changelogs is kinda hassle. It's quite easy to miss a change by accident especially on OSS which accepts random contributors. Nowadays, there are many ways to generate it automatically, and we should migrate to that IMHO. Or, at least we should lint against it not to miss.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not a fan of automatic change logs. That doesn't mean I'm against it. It just means that I'm the wrong guy to set it up. Ultimately I don't care how we do it, as long as we keep a change-log.

@JohnTitor
Copy link
Member

I would also like if somebody would enable the GitHub discussion feature. A link to the discussions is included in the issue creation dialog.

Enabled!: https://github.com/notify-rs/notify/discussions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JohnTitor JohnTitor JohnTitor left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dfaust @JohnTitor