Added how to submit issues to the readme, updated in contrib

This commit is contained in:
FireBall1725 2014-09-29 21:00:30 -04:00
parent 87126e1f11
commit 5be4766c2c
2 changed files with 33 additions and 22 deletions

View file

@ -9,29 +9,21 @@ top of things.
### Reporting an Issue ### Reporting an Issue
When reporting issues, it is critically important that you provide as much Applied Energistics 2 crashing, have a suggestion, found a bug? Create an issue now!
detail as possible. Without this detail, it is impossible for us to track
down what the real issue is.
When creating a new issue, please include the following items, at a minimum. 1. Make sure your issue hasn't already been answered or fixed. Also think about whether your issue is a valid one before submitting it.
Issues that do not contain the following will be closed. Sorry, but we don't 2. Go to [the issues page](https://github.com/AppliedEnergistics/Applied-Energistics-2/issues)
have the time to chase down "My inscriber doesn't work" or "ae crashes" 3. Click new issue
type of issues. 4. Enter your Issue's title (something that summarizes your issue), and then create a detailed description of the issue.
* To help in resolving your issues please try to include the follow if applicable:
```` * The problem that is happening?
What version of Minecraft * What was expected?
What version of Forge * How to reproduce the problem?
What version of AE2 - If this is not the latest version of AE, does the problem * Server or Single Player?
happen on the latest version? * Mod Pack using and version?
* Crash log (Please make sure to use [pastebin](http://pastebin.com/) for the log file)
If this is a crash, provide the crash log. You can use http://pastebin.com * Screen shots or Pictures of the problem
to upload the log. 5. Click `Submit New Issue`, and wait for feedback!
If a specific setup is causing the crash or failure, post a screen shot. You can
use http://imgur.com/ or http://puush.me/ to host the screen shot. In some cases a world download is required with a minimal setup of the bug to reproduce this.
Describe in full detail exactly how to reproduce the failure.
````
### Submitting Changes ### Submitting Changes

View file

@ -7,6 +7,7 @@
* [License](#license) * [License](#license)
* [Downloads](#downloads) * [Downloads](#downloads)
* [Installation](#installation) * [Installation](#installation)
* [Issues](#issues)
* [Building](#building) * [Building](#building)
* [Contribution](#contribution) * [Contribution](#contribution)
* [Credits](#credits) * [Credits](#credits)
@ -33,6 +34,24 @@ Downloads can be found on [CurseForge](http://www.curse.com/mc-mods/minecraft/22
You install this mod by putting it into the `minecraft/mods/` folder. It has no additional hard dependencies. You install this mod by putting it into the `minecraft/mods/` folder. It has no additional hard dependencies.
## Issues
Applied Energistics 2 crashing, have a suggestion, found a bug? Create an issue now!
1. Make sure your issue hasn't already been answered or fixed. Also think about whether your issue is a valid one before submitting it.
2. Go to [the issues page](https://github.com/AppliedEnergistics/Applied-Energistics-2/issues)
3. Click new issue
4. Enter your Issue's title (something that summarizes your issue), and then create a detailed description of the issue.
* To help in resolving your issues please try to include the follow if applicable:
* The problem that is happening?
* What was expected?
* How to reproduce the problem?
* Server or Single Player?
* Mod Pack using and version?
* Crash log (Please make sure to use [pastebin](http://pastebin.com/) for the log file)
* Screen shots or Pictures of the problem
5. Click `Submit New Issue`, and wait for feedback!
## Building ## Building
1. Clone this repository via 1. Clone this repository via