Contributing

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/chenyuan99/swelist/llms.txt

Use this file to discover all available pages before exploring further.

​

Contributing to swelist

​

GitHub Repository

• Repository: https://github.com/chenyuan99/swelist
• Issues: Report bugs or request features
• Pull Requests: Submit your contributions

​

Development Setup

​

Prerequisites

• Python 3.7 or higher
• pip package manager

​

Setting Up Your Environment

1. Fork and clone the repository:
   git clone https://github.com/YOUR-USERNAME/swelist.git
   cd swelist
   
2. Install the package in development mode:
   pip install -e .
   
3. Install development dependencies (if available):
   pip install -e ".[dev]"
   

​

Testing

• Check the CI status
• View code coverage reports

​

Running Tests

# Run tests
pytest

# Run tests with coverage
pytest --cov=swelist

​

Pull Request Guidelines

1. Create a new branch for your feature or bug fix:
   git checkout -b feature/your-feature-name
   
2. Make your changes and ensure they follow the project’s coding style
3. Test your changes thoroughly
4. Commit your changes with clear, descriptive commit messages:
   git commit -m "Add feature: description of your changes"
   
5. Push to your fork:
   git push origin feature/your-feature-name
   
6. Submit a Pull Request with:
   • A clear title and description
   • Reference to any related issues
   • Description of the changes made
   • Any relevant testing information

​

Areas for Contribution

• Bug fixes: Help resolve issues reported by users
• Feature enhancements: Add new filtering options or improve existing features
• Documentation: Improve README, add examples, or fix typos
• Testing: Increase test coverage or add edge case tests
• Performance: Optimize data fetching or filtering algorithms

​

Code Style

• Follow Python PEP 8 style guidelines
• Use meaningful variable and function names
• Add comments for complex logic
• Keep functions focused and modular

​

Questions?

• Open an issue on GitHub
• Review existing issues and pull requests
• Check the project’s CI/CD status for testing requirements

​

License