瀏覽代碼

adding contributing doc

David Ray 8 年之前
父節點
當前提交
3f87c359c5
共有 1 個文件被更改,包括 30 次插入0 次删除
  1. 30 0
      contributing.md

+ 30 - 0
contributing.md

@@ -0,0 +1,30 @@
+# Contributing
+
+We love pull requests from everyone. By participating in this project, you
+agree to abide by the Wagtail [code of conduct].
+
+[code of conduct]: https://github.com/wagtail/wagtail/blob/master/CODE_OF_CONDUCT.md
+
+If you do not have write access to the repo, fork, then clone the repo:
+
+    git clone git@github.com:your-username/bakerydemo.git
+
+Set up your machine for [development]:
+
+[development]: https://github.com/wagtail/bakerydemo/blob/master/readme.md
+
+Push to your fork and [submit a pull request][pr].
+
+[pr]: https://github.com/wagtail/bakerydemo/compare/
+
+For contributors that have write access, if you create a PR that is not
+ready for review, please assign the **work in progress** label to the PR. Once ready
+for review, please remove **work in progress** label and assign the **needs review**
+label to the PR.
+
+Please use your best judgement if committing directly to master. All non-trivial development
+should be done on a branch.
+
+At this point you're waiting on us. We like to at least comment on pull requests
+within three business days (and, typically, one business day). We may suggest
+some changes or improvements or alternatives.