Skip to content

Commit

Permalink
Add pr and issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
alex2276564 committed Nov 1, 2024
1 parent 94c6327 commit 00ce3b8
Show file tree
Hide file tree
Showing 3 changed files with 175 additions and 0 deletions.
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: Bug Report
description: Report a bug in LeverLock
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Please provide as much information as possible to help us resolve the issue.
- type: input
id: minecraft-version
attributes:
label: Minecraft Version
description: What version of Minecraft are you running?
placeholder: "e.g., 1.16.5"
validations:
required: true

- type: input
id: server-software
attributes:
label: Server Software
description: What server software are you using? (Paper, Spigot, etc.)
placeholder: "e.g., Paper"
validations:
required: true

- type: input
id: plugin-version
attributes:
label: LeverLock Version
description: What version of LeverLock are you using?
placeholder: "e.g., 1.0"
validations:
required: true

- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe the bug and how to reproduce it
placeholder: |
1. Place a lever...
2. Try to...
3. See error...
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What did you expect to happen?
validations:
required: true

- type: textarea
id: config
attributes:
label: Configuration
description: Please provide your config.yml content
render: yaml

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output
render: shell

- type: dropdown
id: antiredstone
attributes:
label: AntiRedstoneClock-Remastered
description: Are you using AntiRedstoneClock-Remastered alongside LeverLock?
options:
- Yes
- No
validations:
required: true
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Feature Request
description: Suggest an idea for LeverLock
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a new feature!
Please provide as much detail as possible about your idea.
- type: textarea
id: feature-description
attributes:
label: Feature Description
description: Describe the feature you'd like to see added
placeholder: A clear and detailed description of what you want to happen
validations:
required: true

- type: textarea
id: use-case
attributes:
label: Use Case
description: Describe the situation where this feature would be useful
placeholder: |
This feature would be useful when...
It would help solve...
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Describe any alternative solutions or features you've considered

- type: checkboxes
id: considerations
attributes:
label: Additional Considerations
options:
- label: This feature would be compatible with AntiRedstoneClock-Remastered
- label: This feature would not impact server performance significantly
- label: This feature would require configuration options
48 changes: 48 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
## Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

Fixes # (issue number)

## Type of change
Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update

## Testing
Please describe the tests you performed:

### Tested Minecraft Versions:
- [ ] 1.16.5
- [ ] 1.17.x
- [ ] 1.18.x
- [ ] 1.19.x
- [ ] 1.20.x
- [ ] 1.21.x

### Tested with AntiRedstoneClock-Remastered:
- [ ] Yes
- [ ] No

## Checklist:
Before submitting your PR, please review the following:

- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have tested my changes with different Minecraft versions
- [ ] I have tested compatibility with AntiRedstoneClock-Remastered (if applicable)
- [ ] My code follows the established code style of the project

## Testing Instructions
Please describe how to test your changes:

1. Step 1...
2. Step 2...
3. ...

## Additional Notes
Add any additional notes about the PR here.

0 comments on commit 00ce3b8

Please sign in to comment.