๐ค Contributing to EmbeddingFramework¶
We welcome contributions from the community! Whether it's fixing bugs, adding new features, or improving documentation, your help is appreciated.
๐ ๏ธ How to Contribute¶
- Fork the repository
- Create a new branch
bash git checkout -b feature/my-feature
- Make your changes
- Commit your changes
bash git commit -m "Add my feature"
- Push to your branch
bash git push origin feature/my-feature
- Open a Pull Request
๐ Code Guidelines¶
- Follow PEP 8 for Python code style.
- Write clear commit messages.
- Include tests for new features.
- Keep documentation up-to-date.
๐งช Running Tests¶
pytest --maxfail=1 --disable-warnings -q
With coverage:
pytest --cov=embeddingframework --cov-report=term-missing
๐ก Suggestions¶
If you have ideas for new features, feel free to open an issue in the repository.
Thank you for contributing! ๐