diff options
| author | Ross Barnowski <rossbar@berkeley.edu> | 2021-02-08 16:02:47 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-08 19:02:47 -0500 |
| commit | ffcedfa20a9c38e0ab5c95ade11ea7c4081261ab (patch) | |
| tree | 4a7eaa11c8ceef22630623f26c4607856e620ba2 /CONTRIBUTING.rst | |
| parent | c52ca57a273604af21564cb21eb483b0835248ac (diff) | |
| download | networkx-ffcedfa20a9c38e0ab5c95ade11ea7c4081261ab.tar.gz | |
Add an FAQ to the developer guide for new contributors (#4556)
* Add contributor faq to developer guide.
* Add FAQ to developer guide toctree.
* Fix internal links to development workflow.
* Fix more broken links.
* Replace nbplot with code-block for ipy example.
* Add intersphinx link to sphinx-gallery.
* General proofreading and add a few more links
* Fix example naming convention.
Co-authored-by: Jarrod Millman <jarrod.millman@gmail.com>
* Remove confusing example heading.
* Add git grep to convo on pattern-matching utils.
* Add links to GH issues and discussions to FAQ.
* Modify faq title to make clear it's for newcomers.
* More descriptive filename for faq.
* Add note to contributor guide for new OSS contributors.
Co-authored-by: Jarrod Millman <jarrod.millman@gmail.com>
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 689c778c..177ab162 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -3,6 +3,13 @@ Contributor Guide ================= +.. note:: + This document assumes some familiarity with contributing to open source + scientific Python projects using GitHub pull requests. If this does not + describe you, you may first want to see the :ref:`contributing_faq`. + +.. _dev_workflow: + Development Workflow -------------------- |