Skip to content

Guidelines for submiting an issue

Johnsmith0508 edited this page Oct 21, 2014 · 10 revisions

So, you found an issue in my code? or do you have an idea for the mod? you should read this article before continuing, so that your issue is not marked as invalid and closed. NOTE: if you are using an experamental version, visit this part also

Starting

first off, it is suggested that you do these steps all at once, after you read this entire article.

if you are stuck on finding the issue tracker, click on the circled ! or just click here. the first thing you should do when you get there is look for other issues that address the same thing (the search bar is a great help). if that is the case, write a comment on it saying something along the lines of

can confirm {insert relevant information here}

if not, click ont the big green new issue button

How to write a good title

for my repositories, the issue reports generally look like [version#] brief description of issue. an example of it done correctly could be [1.7.10-1.4] Uncrafting of Dense Blocks.

Writing the body

the body should be brief, but fully explain the issue. if it crashes the game, a link to a pastebin, or a [gist](http://gist. Github.com) should be included somewhere in the report. pictures are always appreciated and can be dropped in the bar at the bottom, or pasting them. the main body is parsed in markdown, so make it look good. some of the guides i have used are from markdown here and [Github guides](https://guides. Github.com/features/mastering-markdown/). still not quite getting it? no problem, check out issue #3 on the tracker for an example

##Feature Requests a feature request is basicaly you (the person with the idea) telling us (the developers) that you want this feature in the mod, but don't know how / don't want to add it yourself. the only diiffrence between this and an issue report lies in the title. the begining should proudly frature a [Feature Request] thing, folowed by what you want added. the discription body should contain what exactly this feature should do. still stuck? look at issue #12 on the tracker for an example.