dev.mdx 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. ---
  2. title: '👨‍💻 Development'
  3. description: 'Contribute to Embedchain framework development'
  4. ---
  5. Thank you for your interest in contributing to the EmbedChain project! We welcome your ideas and contributions to help improve the project. Please follow the instructions below to get started:
  6. 1. **Fork the repository**: Click on the "Fork" button at the top right corner of this repository page. This will create a copy of the repository in your own GitHub account.
  7. 2. **Install the required dependencies**: Ensure that you have the necessary dependencies installed in your Python environment. You can do this by running the following command:
  8. ```bash
  9. make install
  10. ```
  11. 3. **Make changes in the code**: Create a new branch in your forked repository and make your desired changes in the codebase.
  12. 4. **Format code**: Before creating a pull request, it's important to ensure that your code follows our formatting guidelines. Run the following commands to format the code:
  13. ```bash
  14. make lint format
  15. ```
  16. 5. **Create a pull request**: When you are ready to contribute your changes, submit a pull request to the EmbedChain repository. Provide a clear and descriptive title for your pull request, along with a detailed description of the changes you have made.
  17. ## Team
  18. ### Authors
  19. - Taranjeet Singh ([@taranjeetio](https://twitter.com/taranjeetio))
  20. - Deshraj Yadav ([@deshrajdry](https://twitter.com/deshrajdry))
  21. ### Citation
  22. If you utilize this repository, please consider citing it with:
  23. ```
  24. @misc{embedchain,
  25. author = {Taranjeet Singh, Deshraj Yadav},
  26. title = {Embechain: The Open Source RAG Framework},
  27. year = {2023},
  28. publisher = {GitHub},
  29. journal = {GitHub repository},
  30. howpublished = {\url{https://github.com/embedchain/embedchain}},
  31. }
  32. ```