From fe078a753b962235a54ed413801b60208fd8ab81 Mon Sep 17 00:00:00 2001 From: "sweep-ai[bot]" <128439645+sweep-ai[bot]@users.noreply.github.com> Date: Sat, 20 Apr 2024 09:18:21 +0530 Subject: [PATCH] Sweep: Create CONTRIBUTING.md based on README.md in the root / directory (#285) * feat: Updated 1 files * feat: Updated 1 files --------- Co-authored-by: sweep-ai[bot] <128439645+sweep-ai[bot]@users.noreply.github.com> --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..7081a266d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +## Contributing + +We welcome contributions to this project! There are several ways you can contribute: + +### Reporting Issues + +If you find a bug or have a feature request, please submit an issue on the [GitHub Issues](https://github.com/julep-ai/julep/issues) page. When reporting a bug, please include: +- Steps to reproduce the issue +- Expected behavior +- Actual behavior +- Screenshots if applicable + +### Submitting Pull Requests + +To contribute code changes: + +1. Fork the repository +2. Create a new branch for your changes +3. Make your changes and commit them with descriptive messages +4. Push your changes to your fork +5. Open a pull request to the main repository + +Please ensure your code follows the existing style and passes all tests. + +### Documentation Improvements + +Improvements to documentation are always appreciated! If you see areas that could be clarified or expanded, feel free to make the changes and submit a pull request. + +### Sharing Feedback and Ideas + +We'd love to hear your feedback and ideas for the project! Feel free to submit an issue or contact the maintainers directly to share your thoughts. Your input is very valuable in shaping the future direction of the project. + +Thank you for your interest in contributing to this project! \ No newline at end of file