summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMatthew Craig <mattwcraig@gmail.com>2015-02-08 20:18:28 -0600
committerMatthew Craig <mattwcraig@gmail.com>2015-02-08 20:18:28 -0600
commita8a6a72a7a41f70676c180cf38fb919ae997e7e8 (patch)
treef3f0539591426581091eebcbbe93ff65065da4c2 /CONTRIBUTING.md
parentd930eddeadd0e1cd8e8aa748b1de9afa49899542 (diff)
downloadnumpy-a8a6a72a7a41f70676c180cf38fb919ae997e7e8.tar.gz
DOC: add CONTRIBUTING.md that will be automatically displayed on github
Rather than reproducing the details of contribution guidelines it points contributors to the existing documentation.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..98c041a10
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,22 @@
+# Contributing to numpy
+
+## Reporting issues
+
+When reporting issues please include as much detail as possible about your
+operating system, numpy version and python version. Whenever possible, please
+also include a brief code example that demonstrates the problem.
+
+## Contributing code
+
+Thanks for your interest in contributing code to numpy!
+
++ If this is your first time contributing to a project on GitHub, please read
+through our
+[guide to contributing to numpy](http://docs.scipy.org/doc/numpy-dev/dev/index.html)
++ If you have contributed to other projects on GitHub you can go straight to our
+[development workflow](http://docs.scipy.org/doc/numpy-dev/dev/gitwash/development_workflow.html)
+
+Either way, please be sure to follow our
+[convention for commit messages](http://docs.scipy.org/doc/numpy-dev/dev/gitwash/development_workflow.html).
+
+