CONTRIBUTING.md

Contributing to Codebase Agent

Thank you for considering contributing to Codebase Agent! We welcome all kinds of contributions.

Ways to contribute

We welcome your help in multiple directions. Feel free to pick the one that best matches your skills and interest:

• Improving documentation. All our documentation is currently in the project README.
• Simplifying the setup. All setup instructions are documented in the README.
• Features. Check the issues tab or propose new features!
• UI/UX. The chat experience is via Streamlit. Suggestions for improvements are welcome.

Code contributions

For code contributions in particular, we suggest the following workflow:

• Fork the repository
• Clone the repository locally to your machine
• Make changes and commit them
• Push the branch to your local fork
• Submit a pull request with the described changes.
• If you are addressing an existing issue or feature request, make sure to reference it under the "Development" section of the pull request.

Non-code contributions

• If you simply have suggestions for improvement or marketing materials, let us know via Discord.

Hacktoberfest 2024

We welcome Hacktoberfest contributions for all the items above. Issues that we consider particularly beginner-friendly are marked with the "hacktoberfest" label.