Skip to content

Commit

Permalink
Update index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
ninamiolane authored May 22, 2023
1 parent 37ca08a commit b5e89b2
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ process for both novice and experienced contributors.
`TopoEmbedX <https://github.com/pyt-team/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
Expand Down Expand Up @@ -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.
Expand All @@ -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:
Expand Down

0 comments on commit b5e89b2

Please sign in to comment.