Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 560 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 560 Bytes

Contributing

How To

Code

  1. Fork the repo
  2. Make a change
  3. Create and/or update tests
  4. Run tests and ensure they pass
python -m unittest discover -v
  1. Submit a PR

Docs

  1. Fork the repo

  2. Navigate to docs

  3. Make a change

  4. Rebuild docs

    make html
open build/html/index.html # open index.html for review in browser

Package

Contributors should ignore the steps below.

rm -rf build dist py_readability_metrics.egg-info && python setup.py sdist bdist_wheel
twine upload dist/*