summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorNathaniel J. Smith <njs@pobox.com>2016-02-23 22:35:28 +0000
committerNathaniel J. Smith <njs@pobox.com>2016-02-23 22:35:28 +0000
commit077b0ebfe87b2c541f5b76ea3f65298ae39c8f62 (patch)
tree7fb79a78a4fe69e6d0e2d6074fcf7da26b54618e /doc/source
parent9fe706bbda28438363616442778d9c9fca254907 (diff)
parent92fbcaa911d09333b12702e03b03fc4b0751e0cf (diff)
downloadnumpy-077b0ebfe87b2c541f5b76ea3f65298ae39c8f62.tar.gz
Merge pull request #7295 from rehassachdeva/update_dev_doc
DOC: understanding code and getting started section to dev doc
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/dev/development_environment.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/source/dev/development_environment.rst b/doc/source/dev/development_environment.rst
index f3f24aab7..ed8ff5828 100644
--- a/doc/source/dev/development_environment.rst
+++ b/doc/source/dev/development_environment.rst
@@ -203,3 +203,18 @@ typically packaged as ``python-dbg``) is highly recommended.
.. _virtualenvwrapper: http://www.doughellmann.com/projects/virtualenvwrapper/
.. _Waf: https://code.google.com/p/waf/
+
+Understanding the code & getting started
+----------------------------------------
+
+The best strategy to better understand the code base is to pick something you
+want to change and start reading the code to figure out how it works. When in
+doubt, you can ask questions on the mailing list. It is perfectly okay if your
+pull requests aren't perfect, the community is always happy to help. As a
+volunteer project, things do sometimes get dropped and it's totally fine to
+ping us if something has sat without a response for about two to four weeks.
+
+So go ahead and pick something that annoys or confuses you about numpy,
+experiment with the code, hang around for discussions or go through the
+reference documents to try to fix it. Things will fall in place and soon
+you'll have a pretty good understanding of the project as a whole. Good Luck!