Creating Pull Requests

In order to properly create a Pull Request that is easily testable by other users, please follow these steps:

1. Create a new branch to commit your work to.

a. If working on the current version, master is the appropriate branch to create from.

b. If working on a previous version, create a new branch based on the version branch.

2. Before each commit, be sure to run "perl build.py" from your terminal in the koha directory to build the kpz file.

a. For testing, always install from the kpz file to avoid any file permission issues.

3. When work is complete:

a. Update the version.json File

i. Major Version should align with the Koha version it is designed for (20.05, 20.11, 21.05, etc.)

ii. Minor Version is meant to be iterated with each merge. For example, moving from 001 to 002.

iii. Release notes should discuss what you fixed.

iv. If needed, update the readme as appropriate.

b. Build the kpz file as above and commit the changes to your repo.

c. Create a Pull Request for review to merge with the appropriate branch.

i. Include instructions on what you expect to be tested and any concerns you would like testers to focus on.

d. Once at least one user has approved the work, the PR should be ready to merge.

e. Close any related issues with notes about which PR fixed the issues.