CONTRIBUTING.md

Contributing Guide

Contributions are always welcome! Check out the GitHub issue trackers for both this Python port and/or the original R post for some ideas on how to contribute.

• Raise issues if you have ideas.
• Submit pull requests if you want to help improve these resources.
• Star this repo if you want to follow updates.
• Fork this repo if you want to make your own spin!

Project structure

.
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.txt
├── Makefile
├── README.md
├── cheatsheets
│   └── ...
├── index.html             # Published HTML.
├── requirements-dev.txt   # Dependencies for development.
├── requirements.txt       # Dependencies.
├── scripts                # Shell scripts for development, testing and deployment.
│   └── ...
├── tests-as-linear.ipynb  # Main notebook.
└── tests_as_linear        # Supporting Python source code.
    ├── __init__.py
    ├── plots.py           # Functions for large plots in main notebook.
    └── utils.py           # Utility functions used in main notebook.

Development instructions

git clone [email protected]:<USERNAME>/tests-as-linear.git
cd tests-as-linear/
make venv
source venv/bin/actviate
# Do your work...
make publish
make check
deactivate

Please make sure that make publish and make check successfully complete before committing and pushing: these commands generate publishable HTML files, lint the Python modules and run various test scripts.