Contributing to ChromStream¶

Thank you for your interest in contributing to ChromStream! This package is in active development and we welcome contributions from the community.

Ways to Contribute¶

Bug Reports¶

If you find a bug, please submit an issue on our GitHub repository with: - A clear description of the issue - Steps to reproduce the problem - Your environment details (Python version, OS, etc.) - Sample data files if relevant

Feature Requests¶

Have an idea for a new feature? Great! Please submit a feature request as an issue with: - A detailed description of the proposed feature - Use cases and examples

File Format Support¶

If you have a specific file format that ChromStream doesn't currently support: - Please provide an example file - Include documentation about the format if available - Describe the software that generates these files

Code Contributions¶

We welcome pull requests! Here's how to get started:

Fork the repository on GitHub

Clone your fork locally:

git clone https://github.com/your-username/ChromStream
cd ChromStream

Set up the development environment:
```
pip install -e .
```

Create a branch for your changes:

git checkout -b feature/your-feature-name

Make your changes and add tests if applicable
Commit your changes with a clear commit message
Push to your fork and submit a pull request

Development Roadmap¶

Current priorities include: - Support for more file formats - Addition of spectroscopy data sources - JSON saving and parsing functionality - Comprehensive tests

Getting Help¶

If you need help with development, please do not hesitate to reach out. We appreciate all contributions, no matter how small!