Improve CONTRIBUTING.md with practical contribution examples #236
Description
The current CONTRIBUTING.md file could be improved by adding concrete contribution workflows and examples. This would make the contribution process more accessible, especially for new developers.
A first suggestion is to include a dedicated section explaining How to add support for a new sensor in EOReader. This would cover:
- Where to define the new sensor class
- How the reader factory works
- How to map spectral bands using EOReader's standard aliasing system
- Guidelines for writing unit and integration tests
- How to document the new sensor in the codebase and changelog
- Any naming or structural conventions (e.g. inspiration from Sentinel-2)
Possible architecture for the section:
- Creating a new sensor class
- Band mapping logic
- Testing
- Documentation updates (where and how to document the sensor)
- Common patterns (shared logic through sensors)
This issue can later be enriched with additional examples of typical contributions such as:
- Adding a new alias or index (e.g., NDWI)
- Enhancing or fixing documentation (including docstrings or API usage examples)