Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 2.21 KB

File metadata and controls

79 lines (55 loc) · 2.21 KB

Contributing to GeoVision

We love your input! We want to make contributing to GeoVision as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Code Style

  • Use Black for Python code formatting
  • Follow PEP 8 style guidelines
  • Write meaningful commit messages
  • Add docstrings to all functions and classes

Testing

  • Write tests for new features
  • Ensure all tests pass before submitting PR
  • Aim for high test coverage

Setting Up Development Environment

# Clone your fork
git clone https://github.com/yourusername/geovision.git
cd geovision

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install in development mode
pip install -e .
pip install -r requirements-dev.txt

# Run tests
pytest

# Format code
black src/ tests/

Any contributions you make will be under the MIT Software License

When you submit code changes, your submissions are understood to be under the same MIT License that covers the project.

Report bugs using GitHub's issue tracker

We use GitHub issues to track public bugs. Report a bug by opening a new issue.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

License

By contributing, you agree that your contributions will be licensed under its MIT License.