Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

107 changes: 107 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
name: Bug Report
description: Report a bug in the notify workspace
title: "[Bug]: "
labels: ["bug"]
assignees: []

body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug! Please provide the essential details below.

- type: checkboxes
id: prerequisites
attributes:
label: Prerequisites
options:
- label: I searched existing issues to avoid duplicates
required: true

- type: dropdown
id: component
attributes:
label: Component
description: Which component is affected by this bug?
options:
- notify (core library)
- notify-debouncer-full
- notify-debouncer-mini
- file-id
- Multiple components (specify below)
- Unsure
validations:
required: true

- type: dropdown
id: os
attributes:
label: Operating System
description: What operating system are you using?
options:
- Linux
- macOS
- Windows
- BSD
- Other (specify below)
validations:
required: true

- type: input
id: notify-version
attributes:
label: Notify Version
description: Version of notify (and related crates) you're using
placeholder: e.g., notify = "6.1.1", notify-debouncer-full = "0.3.1"
validations:
required: true

- type: dropdown
id: backend
attributes:
label: Notify Backend
description: Which backend is being used?
options:
- Unknown/Auto-detected
- inotify (Linux)
- fsevents (macOS)
- kqueue (macOS/BSD)
- ReadDirectoryChangesW (Windows)
- polling (all platforms)
validations:
required: true

- type: textarea
id: description
attributes:
label: Bug Report
description: Use the template below to describe your issue (remove sections that don't apply)
value: |
## What happened?
<!-- Clear description of the bug and what you expected to happen instead -->


## Steps to reproduce
<!-- Detailed steps to reproduce the issue -->


## Environment details
<!-- Any relevant details like filesystem type, container environment, etc. -->


## Error messages or logs
<!-- Include any error messages, stack traces, or relevant log output -->


## Minimal code example
<!-- Provide a minimal code snippet that reproduces the issue -->
```rust
use notify::{Watcher, RecommendedWatcher, Result};

fn main() -> Result<()> {
// Your minimal reproduction case here
Ok(())
}
```
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discussions
url: https://github.com/notify-rs/notify/discussions
about: Ask questions and discuss notify with the community
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Documentation
description: Report documentation issues or suggest improvements
title: "[Docs]: "
labels: ["documentation"]
assignees: []

body:
- type: markdown
attributes:
value: |
Help us improve the documentation!

- type: input
id: location
attributes:
label: Location
description: Where is the documentation issue?
placeholder: "docs.rs URL, README section, code comments, etc."
validations:
required: true

- type: textarea
id: issue
attributes:
label: What's the issue?
description: Describe the documentation problem
validations:
required: true
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Feature Request
description: Suggest a new feature
title: "[Feature]: "
labels: ["enhancement"]
assignees: []

body:
- type: markdown
attributes:
value: |
Have an idea for a new feature? Tell us about it!

- type: checkboxes
id: prerequisites
attributes:
label: Prerequisites
options:
- label: I searched existing issues and this feature doesn't exist
required: true

- type: textarea
id: feature-request
attributes:
label: Feature Request
description: Describe your feature request using the template below (remove sections that don't apply)
value: |
## Problem
<!-- What problem does this solve? What need or frustration would this feature address? -->


## Proposed Solution
<!-- How would you like this feature to work? -->


## Use Case
<!-- How would you use this feature in practice? -->


## Alternatives
<!-- What workarounds are you using now? -->


## Code Example (optional)
<!-- Show how the feature might be used -->
```rust
use notify::{Watcher, RecommendedWatcher, Result};

fn example() -> Result<()> {
// Your proposed API here
Ok(())
}
```
validations:
required: true
24 changes: 15 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
<!-- By contributing, you agree to the terms of the license, available in the LICENSE.ARTISTIC file, and of the code of conduct, available in the CODE_OF_CONDUCT.md file. Furthermore, you agree to release under CC0, also available in the LICENSE file, until Notify has fully transitioned to Artistic 2.0. -->
<!--
## Contribution Agreement
By contributing, you agree to the license terms (CC Zero 1.0 for notify crate, MIT/Apache 2.0 for the rest) and the code of conduct in CODE_OF_CONDUCT.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.

It is expected that if any failures occur in the builds, you either:
## Testing
The test suite will run after creating this PR. If builds fail, you must either fix the errors, ask for help, or provide a detailed explanation of why failures are expected. If you don't, a maintainer may prompt you, but it will take longer for your contribution to be reviewed.
- fix the errors,
- ask for help, or
- note that the failures are expected with a detailed explanation.
## Code Quality
Running `cargo fmt` and `cargo clippy` is appreciated but not required.
If you do not, a maintainer may prompt you and/or do it themselves, but do note that it will take longer for your contribution to be reviewed if the build does not pass.
You can delete this comment after reading.
-->

Running `cargo fmt` and/or `cargo clippy` is NOT required but appreciated!
## Description
<!-- Describe your changes here -->

You can remove this text. -->
## Related Issues
<!-- Link any related issues -->
Loading