summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorrehassachdeva <aquannie@gmail.com>2016-02-21 01:33:12 +0530
committerrehassachdeva <aquannie@gmail.com>2016-02-22 23:45:57 +0530
commit92fbcaa911d09333b12702e03b03fc4b0751e0cf (patch)
tree26e2ab6fc589d2f445d97ddea22c4ca954fdd9b3 /doc/source
parentfa3cde1b44182297663c69daa41abb576218a2ab (diff)
downloadnumpy-92fbcaa911d09333b12702e03b03fc4b0751e0cf.tar.gz
DOC: Added understanding code and getting started section to development_environment.rst
Updated understanding code section in dev doc wrapped lines, corrected grammar.
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!