Contributing to FastAAExtractor

Thank you for your interest in contributing to FastAAExtractor! We welcome contributions from the community to help improve this bioinformatics tool.

🚀 Ways to Contribute

Bug Reports: Found a bug? Open an issue with detailed steps to reproduce.
Feature Requests: Have an idea? Start a discussion or create an issue.
Code Contributions: Submit pull requests for bug fixes, new features, or improvements.
Documentation: Help improve documentation, tutorials, or examples.
Testing: Test the tool with different datasets and report issues.

Fork and Clone:

git clone https://github.com/yourusername/FastaAAExtractor.git
cd FastaAAExtractor

Set up Environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt

Run Tests:

python src/fasta_aa_extractor.py --genome examples/ECS34.fasta --coords examples/ECS34.tsv --isolate ECS34

Create a Branch: git checkout -b feature/your-feature-name
Make Changes: Ensure your code follows the existing style and includes tests.
Test Thoroughly: Run the tool with various inputs to ensure no regressions.
Update Documentation: If needed, update README.md or add examples.
Commit Changes: Use clear, descriptive commit messages.
Push and PR: Push your branch and create a pull request.

Python Style: Follow PEP 8 guidelines. Use tools like black for formatting.
Docstrings: Add docstrings to functions and classes.
Error Handling: Provide clear error messages for user-facing issues.
Compatibility: Ensure code works on Python 3.6+.
Dependencies: Minimize new dependencies; discuss additions in issues first.

By contributing, you agree that your contributions will be licensed under the same MIT License as the project.

Feel free to start a discussion or open an issue for questions.

Thank you for helping make FastAAExtractor better! 🎉