diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index fec0898a..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,36 +0,0 @@ - - -#### System details - - - -- OS/Platform name and version: -- Rust version (if building from source): `rustc --version`: -- Notify version (or commit hash if building from git): - - - -- If you're coming from a project that makes use of Notify, what it is, and a link to the downstream issue if there is one: -- Filesystem type and options: -- On Linux: Kernel version: -- On Windows: version and if you're running under Windows, Cygwin (unsupported), Linux Subsystem: -- If you're running as a privileged user (root, System): -- If you're running in a container, details on the runtime and overlay: -- If you're running in a VM, details on the hypervisor: - - - - -#### What you did (as detailed as you can) - - - -#### What you expected - - - -#### What happened - - - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..51d7c944 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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? + + + + ## Steps to reproduce + + + + ## Environment details + + + + ## Error messages or logs + + + + ## Minimal code example + + ```rust + use notify::{Watcher, RecommendedWatcher, Result}; + + fn main() -> Result<()> { + // Your minimal reproduction case here + Ok(()) + } + ``` + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..2d2d5f6a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..fb302a78 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..2f8ae28c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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 + + + + ## Proposed Solution + + + + ## Use Case + + + + ## Alternatives + + + + ## Code Example (optional) + + ```rust + use notify::{Watcher, RecommendedWatcher, Result}; + + fn example() -> Result<()> { + // Your proposed API here + Ok(()) + } + ``` + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 62f65596..2865a29a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,21 @@ - + -Running `cargo fmt` and/or `cargo clippy` is NOT required but appreciated! +## Description + -You can remove this text. --> +## Related Issues +