AstralTransRocketries/mcedit
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add CONTRIBUTING.md because it will show up on the "New Issue" page.

Browse Source
This commit is contained in:
David Vierra 2013-04-17 22:53:05 -10:00
parent 93e8c91085
commit b4b560dfd4
1 changed files with 63 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,63 @@
# Reporting Issues
**Before** submitting an issue, read [Reporting Issues](https://github.com/mcedit/mcedit/wiki/Reporting-Issues) and be sure to include all of the required info in your description.
The issue tracker is the preferred channel for [bug reports](#bugs),
[features requests](#features) and [submitting pull
requests](#pull-requests), but please respect the following restrictions:
* Please **do not** use the issue tracker for personal support requests (use the thread on the Minecraft forums or the official MCEdit forums (not yet available)). Asking for help is a personal support request.
<a name="bugs"></a>
## Bug reports
A bug is a _demonstrable problem_ when using MCEdit itself, or when loading a MCEdit-modified world into a vanilla Minecraft game. Modified versions of Minecraft are not officially supported.
Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
1. **Use the GitHub issue search** &mdash; check if the issue has already been
reported. The search box is right next to the "New Issue" button.
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
latest development builds from http://www.mcedit.net/
A good bug report shouldn't leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report. What steps will reproduce the issue? What OS and Minecraft versions
experience the problem? What would you expect to be the outcome? If you use mods, have you tried a vanilla Minecraft install to confirm the problem is not mod-related? All these
details will help people to fix any potential bugs.
Example:
> Short and descriptive example bug report title
>
> Minecraft version(s):
> MCEdit version(s):
> Operating system(s):
> Mods installed:
>
> A summary of the issue. If suitable, include the steps required to reproduce the bug.
>
> 1. This is the first step
> 2. This is the second step
> 3. Further steps, etc.
>
> Any other information you want to share that is relevant to the issue being
> reported. This might include the lines of code that you have identified as
> causing the bug, and potential solutions (and your opinions on their
> merits).
<a name="features"></a>
## Feature requests
Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to *you* to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.
## Contributing