CONTRIBUTING.md

Contributing Guidelines for spaghetti

Thank you for your interest in contributing! We work primarily on Github. Please review the contributing procedures here and here so that we can accept your contributions! Alternatively, contact someone in the development chat channel.

Contact

1. All questions, comments, & discussions should happen in a public forum, where possible. Please start a discussion for questions or open an issue if there appears to be a bug. Private messages and emails will not be answered in a substantive manner.

Style and format

1. Python 3.8, 3.9, 3.10, and 3.11 are the officially supported versions.
2. This project follows the formatting conventions of black and utilizes pre-commit to format commits prior to pull requests being made.
   • LJ Miranda provides an excellent, concise guide on setting up and implementing a pre-commit hook for black.
3. Import packages, classes, and functions with their full name where possible.

• For example:

  ✅

  import spaghetti
  from shapely.geometry import Point

  ❌

  import spaghetti as spgh
  from shapely.geometry import Point as pt