浏览代码

Merge pull request #3918 from markknol/patch-1

Added CONTRIBUTING.md
Simon Krajewski 10 年之前
父节点
当前提交
f2d71e9f80
共有 1 个文件被更改,包括 11 次插入0 次删除
  1. 11 0
      CONTRIBUTING.md

+ 11 - 0
CONTRIBUTING.md

@@ -0,0 +1,11 @@
+Things to check before/while filing an issue:
+
+- Reduce your code to a minimal example (see http://sscce.org/). In particular avoid library dependencies: If you cannot reproduce your issue without using a specific library, it might not be a Haxe issue to begin with.
+- Check if your problems are already resolved in the Haxe development version (for builds see http://builds.haxe.org/).
+- Most targets produce readable code. If you suspect the generated code to be wrong, try checking the output. Note that you can add `-D dump=pretty` to your compilation parameters and find the code which is passed to the generators in a `dump` sub directory.
+
+Other remarks:
+
+- Sometimes people try to be particularly helpful by not only including broken parts in their code, but also "similar" code which is working. More often than not this is more distracting than helpful. If you want to highlight something like this, consider adding the working code commented out.
+- We do not require a classic "What do you see/what do you expect?" form, but in some cases it is hard to figure out where you think the actual problem is otherwise.
+- We're keeping this page quite short so there's a higher chance that people actually read it.