Skip to content

๐Ÿค 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

  1. Fork the repository
  2. Create a new branch bash git checkout -b feature/my-feature
  3. Make your changes
  4. Commit your changes bash git commit -m "Add my feature"
  5. Push to your branch bash git push origin feature/my-feature
  6. 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! ๐ŸŽ‰