CONTRIBUTING.md

CRLF - tool to convert file line-endings

Getting started

Run as module

python -m crlf --help

Setup and install

pip install -r requirements/requirements.txt -r requirements/developer.txt
python setup.py install
crlf --help

Running automatic tests

Run all tests

pytest 

Run the fast tests

pytest -m memory    # only in-memory tests 

Run the slower tests

pytest -m process   # only sub-process tests 

Be incredibly intelligent

pytest --slow-last  # run in-memory tests first, then sub-process later

Frequently asked questions

• Should I run -m memory or -m process tests?

  In terms of functionality, both -m memory and -m process both execute the same suite of tests and are utterly similar. However, there are some differences between them:

  • Tests in -m memory execute much faster (75ms in-memory vs. 2600ms process)
  • Tests in -m process are able to detect structural errors, like improper imports
  • Only tests in -m memory generate coverage