Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Help new contributers by adding CONTRIBUTING.md. #32

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Contributing
============

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Test your changes (`ruff check .`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create new Pull Request
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,4 @@ You can set the configuration either through natural language or manually for bo

## Issues / Contributions

Running into issues? Please file a GitHub issue or join our [Discord](https://discord.gg/dGcwcsnxhU).
Running into issues? Please file a GitHub issue or join our [Discord](https://discord.gg/dGcwcsnxhU). Want to contribute? Learn how by reading [CONTRIBUTING.md](https://github.com/run-llama/rags/blob/main/CONTRIBUTING.md).