Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.63 KB
Raw

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. At the time of this writing, Python 3.10, 3.11, and 3.12 are the officially supported versions.
  2. This project implements the linting and formatting conventions of ruff on all incoming Pull Requests. To ensure a PR is properly linted and formatted prior to creating a Pull Request, install pre-commit in your development environment and then set up the configuration of pre-commit hooks.
  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