Skip to content

Commit

Permalink
updating issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
sminez committed Feb 14, 2025
1 parent f8efea4 commit 358c5aa
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 10 deletions.
24 changes: 16 additions & 8 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,22 @@ assignees: ''

---

### Versions & OS Details

> **Please note that there are currently no official packages of ad**
>
> If you have installed `ad` through a package manager (such as homebrew or the
> aur) then please report any package related issues you are having to the
> maintainer of the package in question. The `ad` README is transparent about
> the current state of the project and the fact that it is not expected to be
> fully stable or suitable for use as your primary text editor at this time.
- ad Version [point version from crates.io or hash of develop]
- OS: [e.g. linux/bsd]
- Distribution [e.g. Ubuntu/Arch]
- OS Version [e.g. 24.04 LTS]


### Describe the bug

...
Expand All @@ -23,12 +39,4 @@ Steps to reproduce the behavior:

If applicable, add screenshots to help explain your problem.

### Versions & OS Details

- OS: [e.g. linux/bsd]
- Distribution [e.g. Ubuntu/Arch]
- OS Version [e.g. 20.04 LTS]
- ad Version [point version from crates.io or hash of develop]

### Additional context

9 changes: 8 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,18 @@ assignees: ''

### Please describe the change / addition you'd like to see made

- Is this completely new functionality, or an enhancement to existing functionality?
- What kind of feature is it that you are requesting?
- Is this completely new functionality, or an enhancement to existing functionality?
- What is the utility provided by this feature and how does it integrate with the
existing features and design of `ad`?


### Is this a feature you have seen in other text editors?

If so, please provide any links or reference to the existing implementation
and some details on how the feature is used.

> Please note that `ad` is minimal by design and is not aiming to add _every_
> feature found in other text editors. There are a lot of fantastic editors
> available, but one of the important things that makes them great is their
> variety and focus on a specific design.
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ assignees: ''

There are a number of resources available that might already have the answer you're after!
Please make sure you have checked them before raising a new issue:
- [Existing GitHub issues](https://github.com/sminez/ad/issues)
- [Existing GitHub issues](https://github.com/sminez/ad/issues?q=is%3Aissue)
- [Open and closed PRs](https://github.com/sminez/ad/pulls?q=)
- [docs.rs docs](https://docs.rs/ad-editor)

If what you are after isn't in there then ask away!

0 comments on commit 358c5aa

Please sign in to comment.