Thank you for your interest in contributing to bookbuddies! We welcome contributions from everyone. By contributing, you help us improve the project and make it better for all users.
Even without writing code, you can contribute to bookbuddies with other skills you have. You can ask about how you can help in the Discord server!
To get started with contributing to bookbuddies, simply set the repo up as described in the readme and use the dev:cli or dev:gui commands depending on what you want to do. Open a pull request once you think it's ready to merge.
If you're unfamiliar with the codebase, you can try working on a good first issue.
Tip
Contributing to a codebase you haven't seen before can seem challenging at first, but you might find that it's easier than you think!
This project uses Prettier for formatting and ESLint for linting. You can check for (and potentially fix) any issues by running bun lint.
The project is set up to help you write code at your pace, so it doesn't include any precommit hooks or run bun lint when you use dev commands. As well as making sure you run it before you commit, this is an opportunity to make sure you have ESLint checks and Prettier format-on-save in your editor.
If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository. Provide as much detail as possible, including steps to reproduce the issue and any relevant error messages.
If you have any questions or need further assistance, see the support info.
We appreciate your contributions!