Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Issues #62

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Improve Issues #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be30f36
remove misinformation
DEATHB4DEFEAT Mar 16, 2024
66892e5
add some comments to the pull request template
DEATHB4DEFEAT Mar 16, 2024
a6abc2c
add feature request template and improve general issue report
DEATHB4DEFEAT Mar 16, 2024
faa0ab7
screenshots are now media
DEATHB4DEFEAT Mar 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
contact_links:
- name: Report a Security Vulnerability
url: https://github.com/space-wizards/space-station-14/blob/master/SECURITY.md
about: Please report security vulnerabilities privately so we can fix them before they are publicly disclosed.
- name: Request a Feature
url: https://discord.gg/rGvu9hKffJ
about: Submit feature requests on our Discord server (https://discord.gg/rGvu9hKffJ).
about: Please report security vulnerabilities to the Space Wizards privately so they can fix them before they are publicly disclosed.
- name: Toolshed Feature Request
DEATHB4DEFEAT marked this conversation as resolved.
Show resolved Hide resolved
url: https://github.com/space-wizards/space-station-14/issues/new?assignees=moonheart08&labels=Toolshed&projects=&template=toolshed-feature-request.md&title=%5BTOOLSHED+REQUEST%5D
about: Suggest a feature for Toolshed (for game admins/developers)
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Request a Feature
about: "Template for noting future planned features. Please ask for approval in the Discord if you aren't an organization Member before posting a feature request"
title: ''
labels: ''
assignees: ''

---

<!--
This is a loose format, write this however you need to
Remove these comments before submitting
-->

# Description
<!--
Explain your request in as much detail as you can
-->

I want Goldfish crackers

# Media
<!--
If applicable, add images or even a video to help explain your suggestion
-->

![Example Screenshot](https://example.com/thisimageisntreal.png)
Comment on lines +1 to +27
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about this instead? Deeper layout, asks for more and provides more. Higher bar for entry as well when people see this.

Suggested change
---
name: Request a Feature
about: "Template for noting future planned features. Please ask for approval in the Discord if you aren't an organization Member before posting a feature request"
title: ''
labels: ''
assignees: ''
---
<!--
This is a loose format, write this however you need to
Remove these comments before submitting
-->
# Description
<!--
Explain your request in as much detail as you can
-->
I want Goldfish crackers
# Media
<!--
If applicable, add images or even a video to help explain your suggestion
-->
![Example Screenshot](https://example.com/thisimageisntreal.png)
---
---
name: Request a Feature
about: "Template for noting future planned features. Ask for approval in the Discord if you aren't an organization Member before posting a feature request to get quick feedback on it, and find out if it's something where generally interested in."
title: ''
labels: ''
assignees: ''
---
<!--
This is a loose format and does not strictly need to be kept, adjust as you'd like.
Ensuere you remove all comments (anything after <!-- to the ending characters, including the start and end characters in question) before submitting your issue.
-->
# Identified Issue or Content Gap
<!--
Explain what you have identified as an issue or gap, be it a power-imbalence, something you feel would make the game better, or simply a cool idea you've come up with.
-->
I am currently hungry. Note that I am not *always* hungry.
This results in me being cranky, and not wanting to do anything.
# Proposed Solution
<!--
Explain your idea or fix in as much detail as you can.
-->
I feel that eating gold fish crackers would solve this, as they would fill the vacuous hole within myself.
# Implementation Details
<!--
If capable, adding details on how you would implement this suggestion is greatly appreciated.
If you are currently unaware, or lack the required skills to understand how to implement it, leave this feild blank. Someone else may fill it in later.
-->
Goldfish crackers can be obtained from the kitchen, my mom put them there last weekend.
About 47 would fill me full. Below is the sequence of events to get them, in psuedocode.
\```
[0] MOVE_TO 'kitchen'
[1] OPEN 'cupboard'
[2] GET 'gf_crackers'
!MARK 'yum'
[3] GET 'goldfish'
[4] EAT 'goldfish'
!IF 'gf_crackers' != 0
GOTO 'yum'
[5] SMILE_BACK
\```
# Media
<!--
If applicable, add images or even a video to help explain your suggestion.
You can simply drag image files onto this page and GitHub will embed them for you.
This can be an example of the problem, or a prototype/example of the suggestion.
-->
![Example Screenshot](https://picsum.photos/512/288)

Had to escape the code block :P

43 changes: 33 additions & 10 deletions .github/ISSUE_TEMPLATE/issue_report.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto as PR template

Original file line number Diff line number Diff line change
@@ -1,32 +1,55 @@
---
name: Report an Issue
about: "..."
about: "Any general issues you have during play or with the codebase"
title: ''
labels: ''
assignees: ''

---

<!--
This is a loose format, write this however you need to
Remove these comments before submitting
-->

# Description
<!--
Explain your issue in detail.
Issues without proper explanation are liable to be closed by maintainers.
Explain your issue in detail
Issues without proper explanation are liable to be closed by maintainers
-->

Description

# Reproduction
<!--
Include the steps to reproduce if applicable.
Try to be as descriptive as possible.
Include the steps to reproduce if applicable
Try to be as descriptive as possible
-->

# Screenshots
1. Open game
2. Game doesn't open

# Expected behavior
<!--
If applicable, add screenshots to help explain your problem.
A video of the reproduction would also be useful.
What should happen?
Why might this not be happening? / Possible solutions (if you know)
-->

1. Open game
2. Game opens

# Media
<!--
If applicable, add screenshots to help explain your problem
A video of the reproduction would also be useful
-->

![Example Screenshot](https://example.com/thisimageisntreal.png)

# Additional context
<!--
Add any other context about the problem here.
Anything you think is related to the issue.
Add any other context about the problem here
Anything you think is related to the issue
-->

There's a ghost in my computer
DEATHB4DEFEAT marked this conversation as resolved.
Show resolved Hide resolved
18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/toolshed-feature-request.md
View file
Open in desktop

This file was deleted.

40 changes: 35 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll read this one in deeper detail later, all read-out right now.

Original file line number Diff line number Diff line change
@@ -1,20 +1,46 @@
<!--
This is a semi-strict format, you can add/remove sections as needed but the order/format should be kept the same
Remove these comments before submitting
-->

# Description

<!--
Explain this PR in as much detail as applicable

Some example prompts to consider:
How might this affect the game? The codebase?
What might be some alternatives to this?
How/Who does this benefit/hurt [the game/codebase]?
-->

Description.

---

# TODO

<!--
A list of everything you have to do before this PR is "complete"
You probably won't have to complete everything before merging but it's good to leave future references
-->

- [ ] Task
- [x] Completed Task

---

<!--
This is default collapsed, readers click to expand it and see all your media
The PR media section can get very large at times, so this is a good way to keep it clean
The title is written using HTML tags
The title must be within the <summary> tags or you won't see it
-->

<details><summary><h1>Media</h1></summary>
<p>

<!-- ![Example Media Embed](https://example.com/thisimageisntreal.png) -->
![Example Media Embed](https://example.com/thisimageisntreal.png)

</p>
</details>
Expand All @@ -23,10 +49,14 @@ Description.

# Changelog

<!-- You can add an author after the `:cl:` to change the name that appears in the changelog, ex: `:cl: Death`, it will default to your GitHub display name -->
<!--
You can add an author after the `:cl:` to change the name that appears in the changelog (ex: `:cl: Death`)
Leaving it blank will default to your GitHub display name
This includes all available types for the changelog
-->

:cl:
- add: Added fun!
- tweak: Tweaked fun!
- add: Added fun :D
- tweak: Tweaked fun
- fix: Fixed fun!
- remove: Removed fun!
- remove: Removed fun :(
Loading