Contributing
bananaDB is an open-source project β contributions are welcome!
Whether you want to report a bug, suggest a feature, or improve the code, this guide will help you get started.
Ways to Contribute
- π Report Bugs β Open an issue describing the problem and steps to reproduce it.
- π‘ Suggest Features β Open an issue to propose new functionality or improvements.
- π§ Submit Code β Fork the repository, make changes in a new branch, and open a Pull Request (PR).
Development Setup
-
Fork the repo on GitHub:
https://github.com/chafed-rc/bananadbΒ -
Clone your fork locally:
git clone https://github.com/YOUR_USERNAME/bananadb.git cd bananadb
-
Install dependencies:
npm install
-
Run the CLI locally:
npm run dev
Pull Requests
- Create a feature branch from
main
. - Write clear commit messages.
- Keep PRs small and focused.
- Make sure tests and lint checks pass.
- Open a PR and describe the changes.
Code of Conduct
Please be respectful and constructive. Contributions should make bananaDB better for everyone.
Maintainers
Only project maintainers (admins) can merge Pull Requests.
All contributions will be reviewed before being included in the project.
π Thanks for helping improve bananaDB!
Last updated on