From b5e89b2e4f76652de1a2892730b7be43c2f9a198 Mon Sep 17 00:00:00 2001 From: Nina Miolane Date: Mon, 22 May 2023 12:44:58 -1000 Subject: [PATCH] Update index.rst --- docs/contributing/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index 00073e8..f233262 100644 --- a/docs/contributing/index.rst +++ b/docs/contributing/index.rst @@ -10,7 +10,7 @@ process for both novice and experienced contributors. `TopoEmbedX `_ is a community effort, and everyone is welcome to contribute. -Making changes +Making Changes -------------- The preferred way to contribute to topoembedx is to fork the `upstream @@ -51,7 +51,7 @@ Follow these steps before submitting a PR: #. Repeat 3. and 4. following the reviewers requests. -Write tests +Write Tests ----------- The tests consist of classes appropriately named, located in the `test` folder, that check the validity of the code. @@ -70,7 +70,7 @@ Test functions should be located in files whose filenames start with `test_`. Fo Use an `assert` statement to check that the function under test returns the correct output. -Run tests +Run Tests ~~~~~~~~~ Install `pytest` which is the software tools used to run tests: