Catalyst Academy

From Koha Wiki
Jump to navigation Jump to search

Every year Catalyst IT run an Academy for High School (or High School age) students.

Catathon 2024: Koha bug squashing session

The Catalyst Rōpū kohinga are hosting a Koha bug squashing session at Catathon 2024, as part of Catalyst IT's 27th birthday.

Installing your Koha development environment

They're all pretty much copy-paste instructions. Once you've generated your personal .env file, there will be a few lines in there to change.

GIT_BZ_PASSWORD=password_from_your_bugs_account
GIT_BZ_USER=you@example.com
GIT_USER_EMAIL=you@example.com
GIT_USER_NAME="John Doe"

Needs a patch

  • Bug 36518 - Add unique IDs to the fieldsets of the item search form to facilitate customization
  • Bug 36067 - Inconsistencies in --commit, --confirm for command line scrips
  • YVONNE Bug 35792 - Quiet warning: Use of uninitialized value $sub6
  • KATRINA Bug 35239 - Missing form field ids in batch patron modification template
  • Bug 35237 - Duplicate ids in markup of patron card layout edit form
  • JEN Bug 35236 - Mismatched label on patron card batch edit form
  • HAAJAR Bug 35235 - Mismatched label on notice edit form
  • Bug 35234 - Several HTML validation issues with the import patrons template
  • SAM Bug 34183 - Remove MARC format hint from OPACResultsLibrary description
  • Bug 34185 - Code mixes OpacItemLocation and OPACItemLocation
  • SAM Bug 33455 - Heading on 'update password' page it too big
  • VICKI Bug 33453 - Confirmation button for 'Record cashup' should be yellow
  • Bug 16700 - Quick spine label creator: Add a hint that IntranetUserCSS can be used for styling
  • JEN Bug 8855 - Link from receipt to invoice
  • MIKE Bug 32218 - Rephrase: Allow OPAC access to users from this domain to login with this identity provider.
  • DORIS Bug 27490 - Rename system preference language to StaffInterfaceLanguages
  • Bug 30245 - Add Turkmen and Sinhala to languages - More advanced, but an example of how to do it is given.
  • NOEMIE Bug 34610 - ProtectSuperlibrarianPrivileges, not ProtectSuperlibrarian

Looking for more? Try this search: https://bugs.koha-community.org/bugzilla3/buglist.cgi?quicksearch=academy

Bits and pieces that might be helpful

Getting started each day

These commands will start up your development environment, log you in, ensure you're using the latest code and packages, and refresh your state.

ktd pull
git fetch origin
git checkout origin/main
ktd up

Writing a patch (vim commands)

vi <filename>
Use `i` to start editing the file
Use `:504` to jump to line 504 in the file
Use `\term` to jump to the next instance of 'term' in the file, then use `n` to jump to the next instance
Use `:wq` to write and quit the file

Writing a commit message

You've finished writing your own patch?

git add <filename> <filename>
git commit

Or you're signing off after testing someone else's patch?

git commit -s

Write your test plan. The start of the file should be 'Bug XXXXX: Description of patch', followed by your test plan

Run the QA test tools to check for some common mistakes:

qa -v 2

Attach the patch to the bug report:

git bz attach -e XXXX HEAD

If there is more than one patch to attach

git bz attach -e XXXX HEAD~Y..

To reset/refresh your dev environment

git checkout origin/master

OR

git reset --hard origin/master

To restart Koha services

restart_all

If you're working on something you want to keep working on tomorrow

git stash

To continue working on the thing from yesterday

git stash apply 

To close your dev environment

exit
ktd down

For help with testing and writing patches

Git bz configuration

Commit messages

Past Academies

Links