Home

Welcome to the thisnotthat wiki!

We'll include some basic documentation on getting started with contributing to this project.

Contributing to the read-the-docs

In order to set up your environment for building the html representation of our readthedocs page follow the following steps.

cd thisnotthat/doc
pip install -r requirements.txt
conda install pandoc
make html

Now examine the html pages to be sure they look like what you were hoping for and correct any strange indentation errors that sphinx complained about. (hint: three spaces is often the right answer)

Setting up and contributing to the code base

(more details should probably be added to this to make it more beginner friendly)

• Fork the project.
• Git clone your fork of the project
• Set https://github.com/TutteInstitute/thisnotthat as the upstream repo
• Make your code changes.
• run black on your code (This is to ensure that we are all using consistent formatting).
• Commit your changes with a commit message
• Push to your fork of thisnotthat
  • it is often useful to merge the upstream branch into your local repository just before submitting a pull request to ensure easy code compatibility.
• Go to your github page and submit a pull request
• One or two of the lead developers will review your pull request and either provide feedback or merge it into the repository.