Skip to content

Commit b645fa3

Browse files
dfaustdfaust
committed
Update github templates
1 parent 04473de commit b645fa3

File tree

6 files changed

+209
-45
lines changed

6 files changed

+209
-45
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
name: Bug Report
2+
description: Report a bug in the notify workspace
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for reporting a bug! Please provide the essential details below.
12+
13+
- type: checkboxes
14+
id: prerequisites
15+
attributes:
16+
label: Prerequisites
17+
options:
18+
- label: I searched existing issues to avoid duplicates
19+
required: true
20+
21+
- type: dropdown
22+
id: component
23+
attributes:
24+
label: Component
25+
description: Which component is affected by this bug?
26+
options:
27+
- notify (core library)
28+
- notify-debouncer-full
29+
- notify-debouncer-mini
30+
- file-id
31+
- Multiple components (specify below)
32+
- Unsure
33+
validations:
34+
required: true
35+
36+
- type: dropdown
37+
id: os
38+
attributes:
39+
label: Operating System
40+
description: What operating system are you using?
41+
options:
42+
- Linux
43+
- macOS
44+
- Windows
45+
- BSD
46+
- Other (specify below)
47+
validations:
48+
required: true
49+
50+
- type: input
51+
id: notify-version
52+
attributes:
53+
label: Notify Version
54+
description: Version of notify (and related crates) you're using
55+
placeholder: e.g., notify = "6.1.1", notify-debouncer-full = "0.3.1"
56+
validations:
57+
required: true
58+
59+
- type: dropdown
60+
id: backend
61+
attributes:
62+
label: Notify Backend
63+
description: Which backend is being used?
64+
options:
65+
- Unknown/Auto-detected
66+
- inotify (Linux)
67+
- fsevents (macOS)
68+
- kqueue (macOS/BSD)
69+
- ReadDirectoryChangesW (Windows)
70+
- polling (all platforms)
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: description
76+
attributes:
77+
label: Bug Report
78+
description: Use the template below to describe your issue (remove sections that don't apply)
79+
value: |
80+
## What happened?
81+
<!-- Clear description of the bug and what you expected to happen instead -->
82+
83+
84+
## Steps to reproduce
85+
<!-- Detailed steps to reproduce the issue -->
86+
87+
88+
## Environment details
89+
<!-- Any relevant details like filesystem type, container environment, etc. -->
90+
91+
92+
## Error messages or logs
93+
<!-- Include any error messages, stack traces, or relevant log output -->
94+
95+
96+
## Minimal code example
97+
<!-- Provide a minimal code snippet that reproduces the issue -->
98+
```rust
99+
use notify::{Watcher, RecommendedWatcher, Result};
100+
101+
fn main() -> Result<()> {
102+
// Your minimal reproduction case here
103+
Ok(())
104+
}
105+
```
106+
validations:
107+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discussions
4+
url: https://github.com/notify-rs/notify/discussions
5+
about: Ask questions and discuss notify with the community

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Documentation
2+
description: Report documentation issues or suggest improvements
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Help us improve the documentation!
12+
13+
- type: input
14+
id: location
15+
attributes:
16+
label: Location
17+
description: Where is the documentation issue?
18+
placeholder: "docs.rs URL, README section, code comments, etc."
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: issue
24+
attributes:
25+
label: What's the issue?
26+
description: Describe the documentation problem
27+
validations:
28+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Feature Request
2+
description: Suggest a new feature
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Have an idea for a new feature? Tell us about it!
12+
13+
- type: checkboxes
14+
id: prerequisites
15+
attributes:
16+
label: Prerequisites
17+
options:
18+
- label: I searched existing issues and this feature doesn't exist
19+
required: true
20+
21+
- type: textarea
22+
id: feature-request
23+
attributes:
24+
label: Feature Request
25+
description: Describe your feature request using the template below (remove sections that don't apply)
26+
value: |
27+
## Problem
28+
<!-- What problem does this solve? What need or frustration would this feature address? -->
29+
30+
31+
## Proposed Solution
32+
<!-- How would you like this feature to work? -->
33+
34+
35+
## Use Case
36+
<!-- How would you use this feature in practice? -->
37+
38+
39+
## Alternatives
40+
<!-- What workarounds are you using now? -->
41+
42+
43+
## Code Example (optional)
44+
<!-- Show how the feature might be used -->
45+
```rust
46+
use notify::{Watcher, RecommendedWatcher, Result};
47+
48+
fn example() -> Result<()> {
49+
// Your proposed API here
50+
Ok(())
51+
}
52+
```
53+
validations:
54+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
1-
<!-- 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. -->
1+
<!--
2+
## Contribution Agreement
3+
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.
24
3-
<!-- After creating this pull request, the test suite will run.
5+
## Changelog
6+
Add an entry to CHANGELOG.md if applicable. Create a new section `## notify (unreleased)` if not already present.
47
5-
It is expected that if any failures occur in the builds, you either:
8+
## Testing
9+
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.
610
7-
- fix the errors,
8-
- ask for help, or
9-
- note that the failures are expected with a detailed explanation.
11+
## Code Quality
12+
Running `cargo fmt` and `cargo clippy` is appreciated but not required.
1013
11-
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.
14+
You can delete this comment after reading.
15+
-->
1216

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

15-
You can remove this text. -->
20+
## Related Issues
21+
<!-- Link any related issues -->

0 commit comments

Comments
 (0)