Skip to content

Commit

Permalink
Merge pull request #51 from Skullians/dev
Browse files Browse the repository at this point in the history
Add issue templates & warning to readme
  • Loading branch information
Sweattypalms authored Sep 17, 2024
2 parents 24fd517 + 6036571 commit cec76b4
Show file tree
Hide file tree
Showing 4 changed files with 127 additions and 2 deletions.
75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name: "Bug Report"
description: If you find a bug or a problem, report it to us here.
labels: [bug, unconfirmed]
body:
- type: markdown
attributes:
value: Bug reports should only be used for reporting issues with how the server works / its features. For general questions, please use our [Discord Server](https://discord.gg/qT5J8EMjwk) instead.

- type: textarea
attributes:
label: Describe the Bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
attributes:
label: To Reproduce
description: Steps to reproduce the unintended behaviour. Include media (images, videos, whatever) if possible in the `Screenshots / Videos` section.
validations:
required: true

- type: textarea
attributes:
label: Expected Behaviour
description: A clear and concise description of what you expect to happen.
validations:
required: true

- type: textarea
attributes:
label: Screenshots / Videos
description: If applicable, add screenshots or videos to help explain your problem.
validations:
required: true

- type: textarea
attributes:
label: FerrumC Version
description: Please provide which version of FerrumC you are using (either github actions run number or release ver).
validations:
required: true

- type: textarea
attributes:
label: Rust Version
description: Provide what Rust version you are using.
validations:
required: true

- type: textarea
attributes:
label: Server Logs
description: Please upload your entire server logs (via github gist, whatever)
validations:
required: true

- type: textarea
attributes:
label: Additional Context
description: Add any other context about the problem here.
validations:
required: true

- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please [search here](https://github.com/ferrumc-rs/ferrumc/issues) to see if an issue already exists for your problem.
options:
- label: I have searched current existing issues before creating this.
required: true
- label: I checked all the boxes without reading them
required: false
- label: I have provided all necessary and relevant details, including logs, reproduction steps, etc.
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: "Feature Request"
description: Suggest a feature or idea for this server.
labels: enhancement
body:
- type: markdown
attributes:
value: This should only be used for new ideas / features. For general questions, please use our [Discord Server](https://discord.gg/qT5J8EMjwk) instead.

- type: textarea
attributes:
label: Is your feature request related to a problem?
description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] Link the GitHub issue if applicable."
validations:
required: true

- type: textarea
attributes:
label: "Describe the solution / feature you'd like."
description: "A clear and concise description of what feature / solution you would like to be implemented."
validations:
required: true

- type: textarea
attributes:
label: "Alternatives you've considered."
description: "A clear and concise description of any alternative solutions / features you've considered."
validations:
required: true

- type: textarea
attributes:
label: "Additional Context"
description: "Add any other context or screenshots about the feature request here."
validations:
required: true

- type: checkboxes
attributes:
label: I have confimed that...
options:
- label: ... such a feature does not exist already.
required: true
- label: ... I ticked all the boxes without reading them
required: false
- label: ... such a feature request has not been submitted already.
required: true

6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,12 @@
<a href="#-license">License</a>
<a href="#-faq">FAQ</a>


</div>

> [!WARNING]
> FerrumC is currently going through a rewrite!\
> Please see the [v3/rewrite branch](https://github.com/ferrumc-rs/ferrumc/tree/rewrite/v3).
## 📖 About

FerrumC is a Minecraft server implementation written from the ground up in Rust. Leveraging the power of the Rust
Expand Down

0 comments on commit cec76b4

Please sign in to comment.