46 lines (35 loc) · 1.1 KB

Contributing to latamdata-py

Thank you for your interest in contributing! 🐍

Development Setup

git clone https://github.com/juanmoisesd/latamdata-py.git
cd latamdata-py
pip install -e ".[dev]"
pre-commit install

Ways to Contribute

🗃️ Add a Dataset

Open a feature request
Include: dataset name, source URL, DOI, description, and sample access code

🐛 Report a Bug

Use the bug report template
Include Python version, OS, and steps to reproduce

💻 Code Contributions

Fork the repository
Create a feature branch: git checkout -b feature/add-new-dataset
Write tests in tests/
Ensure pytest and flake8 pass
Open a Pull Request

Code Style

Format with black: black .
Lint with flake8: flake8 .
Sort imports with isort: isort .
Pre-commit hooks handle this automatically

Running Tests

pytest tests/ -v

Code of Conduct

See CODE_OF_CONDUCT.md.

Citation

See CITATION.cff.