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.

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

GitHub issues and pull requests templates #350

Closed
nullsystem opened this issue Jun 8, 2024 · 0 comments · Fixed by #351
Closed

GitHub issues and pull requests templates #350

nullsystem opened this issue Jun 8, 2024 · 0 comments · Fixed by #351
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@nullsystem
Copy link
Collaborator

To encourage issues writers to write better and more detailed issues, utilizing GitHub's templates would be a good idea. Documentation in here: https://docs.github.com/en/enterprise-cloud@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests

Mostly, for bug report to be filled with steps to reproduce, what's expected vs actual, and some extra details. Feature request to give a description and maybe even pictures of what's wanted.

On top of that, Rain suggested (#349 (review)) it can be linked from the game also, using GitHub issue creation URL feature documented in here: https://docs.github.com/en/enterprise-cloud@latest/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-url-query

@nullsystem nullsystem added the documentation Improvements or additions to documentation label Jun 8, 2024
@nullsystem nullsystem self-assigned this Jun 8, 2024
nullsystem added a commit that referenced this issue Jun 8, 2024
* Add issues template giving an option between bug report or feature request
* Structured especially for bug report so it can be followed through
* Altered slightly from GitHub's given default to fit a bit more for NT;RE

(#350)
nullsystem added a commit that referenced this issue Jun 9, 2024
* Add issues template giving an option between bug report or feature request
* Structured especially for bug report so it can be followed through
* Altered slightly from GitHub's given default to fit a bit more for NT;RE
* Add PR template

* resolves: #350
nullsystem added a commit that referenced this issue Jun 18, 2024
* GitHub issues + PR template

* Add issues template giving an option between bug report or feature request
* Structured especially for bug report so it can be followed through
* Altered slightly from GitHub's given default to fit a bit more for NT;RE
* Add PR template

* resolves: #350

* More comments to aid issue write ups

* PR review changes

* Update bug report to yml forms format

* Change feature_request to yaml

* Added more optional inputs, improve wordings and clarifications

* Add some more links and expand the feature requests a little.

* Fix weird newline breaking the parsing.

* PR review, title space, placeholder example feature req

* Five Ws

---------

Co-authored-by: Linn <hamstertejp@gmail.com>
Rainyan pushed a commit that referenced this issue Jul 1, 2024
* GitHub issues + PR template

* Add issues template giving an option between bug report or feature request
* Structured especially for bug report so it can be followed through
* Altered slightly from GitHub's given default to fit a bit more for NT;RE
* Add PR template

* resolves: #350

* More comments to aid issue write ups

* PR review changes

* Update bug report to yml forms format

* Change feature_request to yaml

* Added more optional inputs, improve wordings and clarifications

* Add some more links and expand the feature requests a little.

* Fix weird newline breaking the parsing.

* PR review, title space, placeholder example feature req

* Five Ws

---------

Co-authored-by: Linn <hamstertejp@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant