Thank you for your interest in contributing to Global Bible Tools! Please familiarize yourself with this document before you open a PR.
We would also appreciate if you filled out this form, so we can get to know you a little better.
If you have an idea or find a bug, create an issue after you've already searched the issues to see if one already exists.
Issues in the Ready column of the project are ready to be worked on. Pick from these issues to have a greater chance of having your PR accepted.
Create a branch from the main branch either in your fork or in project repo to do your work in.
When you have a change that is ready for review, open a PR on GitHub to the main branch. Please note that there is no guarantee a PR will be accepted. Maintainers have limited time, so low quality PRs are likely to be rejected.
- Fill in the PR template to ensure the reviewer has everything necessary for the review
- Use conventional commits as your PR name. The most common prefixes we use are
feat:
,refactor:
,chore:
, anddocs:
. - Link the PR to the issue for reference.
- If opening a PR from a fork, allow the reviewer to make updates to your branch. This can speed up the review process.
- The reviewer may ask for changes. Please make those changes and then mark each comment as resolved when complete. Request a new review when all work is complete.
Congratulations on your contribution! It is much appreciated. Once accepted and merged, your PR will be immediately deployed to globalbibletools.com and be available to all users.