Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note about importance of testing to contributor guide #7103

Merged
merged 1 commit into from
Nov 10, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions doc/developer/new_contributor_faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,18 @@ There is no official policy setting explicit inclusion criteria for new
algorithms in NetworkX. New algorithms are more likely to be included if they
have been published and are cited by others. More important than number of
citations is how well proposed additions fit the project :ref:`mission_and_values`.

Testing is also an important factor in determining whether algorithms
should be included. Proposals that include thorough tests which illustrate
expected behavior are much easier to review, and therefore likely to progress more rapidly.

.. note::
*Thorough* does not mean *exhaustive*. The quality of unit tests is much
more important than quantity. Thorough tests should address questions like:

- Does the algorithm support different graph types (undirected, directed,
multigraphs)?
- How does the algorithm behave with disconnected inputs and graphs which
contain self-loops?
- Are there explicit test cases outlined in the literature which can be
incorporated in the test suite?