Merge nucleic/sleek-thistle-egret-fyej into dev
This commit is contained in:
@@ -0,0 +1,86 @@
|
||||
name: Compatibility Bug Report
|
||||
description: Report a case where brush behaves differently from bash
|
||||
labels: ["bug", "area: compat"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for helping improve brush's compatibility!
|
||||
|
||||
This template is for reporting cases where brush produces different behavior than bash for the same input. Before submitting, please [search existing issues](https://github.com/reubeno/brush/issues) to check if this has already been reported.
|
||||
|
||||
- type: input
|
||||
id: brush-version
|
||||
attributes:
|
||||
label: brush version
|
||||
description: The version of brush you're using. You can find this with `brush --version`.
|
||||
placeholder: "e.g., brush 0.2.9"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: bash-version
|
||||
attributes:
|
||||
label: bash version (for comparison)
|
||||
description: The version of bash you compared against, if applicable. You can find this with `bash --version`.
|
||||
placeholder: "e.g., GNU bash, version 5.2.21(1)-release"
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: dropdown
|
||||
id: platform
|
||||
attributes:
|
||||
label: Platform / OS
|
||||
options:
|
||||
- Linux
|
||||
- macOS
|
||||
- WSL
|
||||
- Windows
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: reproduction
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: >
|
||||
Provide the shell commands, script, or other usage details that
|
||||
reproduced the issue. If you can narrow it down to a minimal
|
||||
reproducing example, that's very helpful but not required.
|
||||
placeholder: |
|
||||
# Example:
|
||||
brush -c 'some command'
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: actual-behavior
|
||||
attributes:
|
||||
label: Actual behavior (brush)
|
||||
description: What did brush do in this case?
|
||||
placeholder: Describe or paste the brush output...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected-behavior
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: >
|
||||
What did you expect to happen? If relevant, what does bash or another
|
||||
comparable shell do in this case?
|
||||
placeholder: Describe or paste the expected output or behavior
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: >
|
||||
Is there anything else you think is important to share? You might consider
|
||||
including additional environment specifics (e.g., relevant .bashrc config),
|
||||
workarounds, related issues, any additional debugging you've performed, etc.
|
||||
validations:
|
||||
required: false
|
||||
@@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Questions & Discussion
|
||||
url: https://github.com/reubeno/brush/discussions
|
||||
about: Ask questions, share ideas, or discuss brush in GitHub Discussions.
|
||||
@@ -0,0 +1,52 @@
|
||||
name: Feature Request
|
||||
description: Suggest a new feature or enhancement for brush
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to suggest an improvement to brush! We welcome and appreciate all input and feedback. While we can't commit to prioritizing or implementing all such requests, we'd rather you make the suggestion than not.
|
||||
|
||||
Our only requests: (1) please ensure you follow our project's [Code of Conduct](https://github.com/reubeno/brush#coc-ov-file), and (2) before submitting, please [search existing issues](https://github.com/reubeno/brush/issues) to check if a similar request already exists. If it does, feel free to add a comment to the existing issue instead.
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Feature description
|
||||
description: A clear and concise description of the feature or enhancement you'd like.
|
||||
placeholder: Describe the feature...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: use-case
|
||||
attributes:
|
||||
label: Use case / motivation
|
||||
description: |
|
||||
Why is this feature important to you? What problem does it solve? How would you use it?
|
||||
|
||||
Providing context helps us understand the value and prioritize accordingly.
|
||||
placeholder: Explain why this feature would be useful...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: proposed-solution
|
||||
attributes:
|
||||
label: Proposed solution
|
||||
description: >
|
||||
If you have ideas on how this could be implemented or how it should work,
|
||||
share them here. Note that this is purely optional.
|
||||
placeholder: Describe how you think this could work...
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: >
|
||||
Any other context, references, or screenshots that would help us understand your request.
|
||||
For example, links to relevant documentation, other shells that implement this, etc.
|
||||
validations:
|
||||
required: false
|
||||
@@ -0,0 +1,19 @@
|
||||
name: Other Issue
|
||||
description: "Report an issue that doesn't fit the other templates"
|
||||
labels: ["state: triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
If your issue is a **feature request**, please use the [Feature Request](https://github.com/reubeno/brush/issues/new?template=feature-request.yml) template instead. If it's about **brush behaving differently from bash** or another compatibility issue, please use the [Compatibility Bug Report](https://github.com/reubeno/brush/issues/new?template=compatibility-bug.yml) template instead.
|
||||
|
||||
For general questions or discussion, consider using [GitHub Discussions](https://github.com/reubeno/brush/discussions).
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: Please describe the issue in detail.
|
||||
placeholder: Describe the issue...
|
||||
validations:
|
||||
required: true
|
||||
Reference in New Issue
Block a user