add CONTRIBUTING.md

1 files changed, 25 insertions, 0 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..17cdcfd07
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,25 @@
+# Contributing
+
+If you discover issues, have ideas for improvements or new features, or
+want to contribute a new module, please report them to the
+[issue tracker][1] of the repository or submit a pull request. Please,
+try to follow these guidelines when you do so.
+
+## Issue reporting
+
+* Check that the issue has not already been reported.
+* Check that the issue has not already been fixed in the latest code
+  (a.k.a. `master`).
+* Be clear, concise and precise in your description of the problem.
+* Open an issue with a descriptive title and a summary in grammatically correct,
+  complete sentences.
+* Include any relevant code to the issue summary.
+
+## Pull requests
+
+* Use a topic branch to easily amend a pull request later, if necessary.
+* Write good commit messages.
+* Use the same coding conventions as the rest of the project.
+* Ensure your edited codes with four spaces instead of TAB.
+
+[1]: https://github.com/waruqi/xmake/issues