-
Notifications
You must be signed in to change notification settings - Fork 904
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Sweep: Create CONTRIBUTING.md based on README.md in the root / direct…
…ory (#285) * feat: Updated 1 files * feat: Updated 1 files --------- Co-authored-by: sweep-ai[bot] <128439645+sweep-ai[bot]@users.noreply.github.com>
- Loading branch information
1 parent
041e862
commit fe078a7
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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! |