Anvilcraft/buildcraft
2
1
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update README.md

Browse source 
Added additional instruction on issues opened on the tracker.
This commit is contained in:
SpaceToad 2014-02-15 23:07:49 +01:00
parent 42c98f757a
commit a91079540f
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,13 +1,21 @@
## Welcome to Buildcraft on GitHub
### Rule on opening issues
**Please only open an issue if you are planning to either fix the bug or implement the feature.**
If you're part of the BuildCraft team, this means that you will set yourself as the assignee. If you're an external contributor, that means that your issue must be a pull request. We are trying to keep the issues list to things that are scheduled for implementation / correction. If you would like to report a bug but do not plan to fix it, please report on the bug reporting board (http://mod-buildcraft.com/forums/index.php?board=2.0). If you would like to suggest a feature, you can start a thread on the feature ideas board (http://mod-buildcraft.com/forums/index.php?board=4.0). New issues that do not follow this rule will get closed, existing ones will be closed progressively.
Assigned features and issues that are not scheduled for any particular release and is left open for several months will get closed eventually. BuildCraft being an open-source project, if this particular fix or feature is important to you, feel free to go ahead and submit a pull request for it.
### Contributing
If you wish to submit a pull request to fix bugs or broken behaviour feel free to do so. If you would like to add
features or change existing behaviour or balance, please discuss it with Sengir or Krapht before submiting the pull request.
features or change existing behaviour or balance, please discuss it on the feature ideas board before (http://mod-buildcraft.com/forums/index.php?board=4.0 before).
Do not submit pull requests which solely "fix" formatting. As these kinds of changes are usually very intrusive in commit history and everyone has their own idea what "proper formatting" is, they should be done by one of the main contributors.
Please only submit "code cleanup", if the changes actually have a substantial impact on readability.
### Reporting issues
* Do not open an issue if you're not planning to fix it, intead open a thread on http://mod-buildcraft.com/forums/index.php?board=2.0
* Before reporting an issue, please check that it has not been reported before.
* Issues are for bugs/crashes, please do not use them to ask general questions.
* Always include the version you are having trouble with. Or if you're building from source, which source you're building.