CONTRIBUTING.md

Development Values

• Reproducible research;
• Precise and accurate implementations from authors;
• Easy deploy;
• Good Documentation;
• Simple API.

Environment setup

Grab it:

$ git clone [email protected]:shrkit/shape-retrieval-toolkit.git

Linux

Prepare ShapeLab for development.

shape-retrieval-toolkit$ pip install -e .
shape-retrieval-toolkit$ pip install -r requirements-dev.txt

Code Guidelines

• Python docstring format is Google's style, more info

Code checklist

• Unit testing (except for some datasets and database tasks)
  • _test package
  • target in tasks-unittest.mk
  • all tests passing
• API documentation
  • Generation OK
• Deployment
  • setup.py package and entry points
  • Continuous build
• UI check:
  • progressbar