andersthemagi / magicalmusings.github.io

Website hosting my own thoughts for TTRPG gameplay / game mastering
https://magicalmusings.github.io/
MIT License
6 stars 8 forks source link

EXAMPLE: Formatting Issue Submissions #10

Closed magicalmusings closed 3 years ago

magicalmusings commented 3 years ago

Here is a basic rundown on how to format issues for players or contributors that may not be familiar with GitHub. A checklist to make sure you include all necessary components is below. It's really not as complicated as it seems, trust me!

EXAMPLE ISSUE : Typo on Homebrew Page

Title: Typo on Homebrew Page Labels: Typo (maybe Good First Issue too?)

Man you spelled 'dumbass' on magicalmusings.github.io/homebrew/ as 'dumbas', dumbass.

[SCREENSHOT OR LINK GOES HERE]

Checklist for Submission:

Pull Requests

If by chance you want to fix it yourself, feel free to link a pull request (see the right-hand side under 'Linked Pull Request' ) with the changes. I'll review it and make sure it won't break the site before merging, and note anything that might need to be adjusted before the request is approved for merge.

magicalmusings commented 3 years ago

An example response: Fixed it! +1 LT your way, thanks for finding that typo.