Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Ready to contribute? Here's how to set up beyondllm
for local development.
-
Fork the
beyondllm
repo on GitHub. -
Clone your fork locally
git clone [email protected]:your_name_here/beyondllm.git
-
Create a branch for local development
git checkout -b <name-of-your-bugfix-or-feature>
Now you can make your changes locally.
-
When you're done making changes, check that your changes pass all the tests tests, including testing other Python versions.
-
Commit your changes and push your branch to GitHub
git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature
-
Submit a pull request through the GitHub website.
Before you submit a pull request, check that it meets these guidelines:
-
The pull request should include tests.
-
If the pull request adds functionality, the docs should be updated.
-
The pull request should work for Python 3.8, 3.9, 3.10 and make sure that the tests pass for all supported Python versions in different platforms like Linux, Mac, Windows.
You can contribute in many ways:
Report Bugs
Report bugs at https://github.com/aiplanethub/beyondllm/.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
Implement Features
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
Write Documentation
BeyondLLM could always use more documentation, whether as part of the official BeyondLLM docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback
The best way to send feedback is to file an issue at https://github.com/aiplanethub/beyondllm/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)