Community Guidelines

Contributing

The project code is domiciled at the GitHub repo https://github.com/temmy222/PyTOUGHREACT

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Contributing to the code would involve you following the below procedures to quickly get started

  1. Clone the repo using preferred cloning method.

  2. Install the library to enable you able to use the test example using

`python pip install -e . `

  1. Modify the code and write tests for the modified code

  2. Tests are conducted with pytest and coverage reports are performed using pytest-cov. Install pytest and pytest-cov using the commands below

`python pip install pytest `

`python pip install pytest-cov `

  1. Run tests: Run the below command from the root folder to run the tests

`python pytest `

  1. Flake8 is also used to ensure code readability. Install flake8 using

`python pip install flake8 ` and run flake8 using

`python flake8 src `

  1. PEP8 Naming package is also used to ensure adherence to PEP8. Install pep8-naming using

`python pip install pep8-naming `

  1. Make a pull request after passing all tests

  2. More information can be found in developer notes in the documentation - https://pytoughreact.readthedocs.io/en/master/developer.html

Report issues or problems with the software

Issues with the software can be raised through the GitHub page under issues https://github.com/temmy222/PyTOUGHREACT/issues and clicking ‘New issue’ on the right green button

After this has been clicked, two kinds of issues can be raised; bug report or a feature request. For each of the type of issues, a form shows up where each sections are to be filled to enable the developers able to adequately replicate and resolve your issue

Support

Software support to new issues after going through the documentations can be received by contacting any of the code owners listed below

  1. Temitope Ajayi - ajayi_temmy@yahoo.com