[Bug 42325] New: Minor corrections for accuracy in error messages and comments in AuthUtils
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42325 Bug ID: 42325 Summary: Minor corrections for accuracy in error messages and comments in AuthUtils Initiative type: --- Sponsorship --- status: Product: Koha Version: Main Hardware: All OS: All Status: NEW Severity: trivial Priority: P5 - low Component: Documentation Assignee: koha-bugs@lists.koha-community.org Reporter: jonadab.theunsightlyone@gmail.com QA Contact: testopia@bugs.koha-community.org CC: aude.charillon@openfifth.co.uk, david@davidnind.com, philip.orr@lmscloud.de Created attachment 196995 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=196995&action=edit Patch: correct error message (about non-positive length) and a couple of comments, for accuracy. In the course of familiarizing myself with the codebase, I ran into a couple of rather minor things that could stand to be fixed up. I have published a branch here: https://github.com/tsadok/Koha/tree/fixes So far, it only has one commit (which only touches one file), here: https://github.com/Koha-Community/Koha/commit/d5ea3ec7fa35b25cb14a6b60c8ddde... -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42325 jonadab.theunsightlyone@gmail.com <jonadab.theunsightlyone@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch complexity|--- |String patch Assignee|koha-bugs@lists.koha-commun |jonadab.theunsightlyone@gma |ity.org |il.com Status|NEW |Needs Signoff -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42325 --- Comment #1 from jonadab.theunsightlyone@gmail.com <jonadab.theunsightlyone@gmail.com> --- Commit message: Minor corrections for accuracy in error messages and comments in AuthUtils None of this is a very big deal, as the immediate context makes it pretty clear what is actually going on (and the error message is sufficiently unique to be straightforward to find in the codebase). Nonetheless, we should be accurate whenever possible. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42325 --- Comment #2 from Aude Charillon <aude.charillon@openfifth.co.uk> --- The Documentation component is mostly used for reports and requests relating to the Koha Manual. I am afraid that if this bug report stays under the Documentation component, it will not get the attention it deserves. Wouldn't it be better under "Architecture, internals and plumbing"? Please go ahead and change it. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42325 jonadab.theunsightlyone@gmail.com <jonadab.theunsightlyone@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Component|Documentation |Architecture, internals, | |and plumbing --- Comment #3 from jonadab.theunsightlyone@gmail.com <jonadab.theunsightlyone@gmail.com> --- Ok, sure. I'm very new here and don't really know the components, so I will not take your word for that. Component updated. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42325 --- Comment #4 from jonadab.theunsightlyone@gmail.com <jonadab.theunsightlyone@gmail.com> --- Err, s/will not/will just/; sorry for any confusion. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42325 jonadab.theunsightlyone@gmail.com <jonadab.theunsightlyone@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Sponsorship status|--- |Unsponsored -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42325 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |dpavlin@rot13.org Component|Architecture, internals, |Authentication |and plumbing | --- Comment #5 from David Nind <david@davidnind.com> --- Hi. Welcome, and thanks for the patch! There is a bit of a process to get code changes to Koha into a release. Some resources to help you: - Our development workflow: https://wiki.koha-community.org/wiki/Development_workflow . From initial reporting, issues go through a workflow . someone writes the code and a patch . it gets signed off by someone else . goes through our QA team . and is then reviewed by the release manager to get into the next release - Development environment: we don't use pull requests or merge requests (and the GitHub repository is only a mirror), instead we use a development environment (koha-testing-docker, or KTD for short) https://gitlab.com/koha-community/koha-testing-docker - Commit messages: we have some guidelines for patch commit messages https://wiki.koha-community.org/wiki/Commit_messages - the main thing is to format it correctly and have a test plan (the test plan is the key, and should be aimed at a general audience - we have a range of people that test bugs including library staff, not just developers who are familiar with or can work out the code). This is obviously a lot to set up for a one-off or occasional change to Koha! There is also the Development channel in our chat tool to ask for help https://chat.koha-community.org/ (registration required). In the interests of helping out, here is my suggestion for the commit message, and I'm happy to update the commit message. --- Bug 42325: Update text for error message and code comments This patch updates the text for an error message and code comments in Koha::AuthUtils (provides utility functions for managing user passwords). Test plan: 1. Review the diff and proposed update to the error message, and make sure it is correct. 2. Review the diff and the proposed updates to the code comments, and make sure they are correct. --- As this is related to authentication (note: I'm not a developer!), I've changed the Koha component to that. Also, as this is something that requires a developer to review, then I'd add a comment to the bug saying signoff required by a developer (as you need to understand the code, rather than work through steps and workflow logic using the staff interface or OPAC). Apologies if this is a lot! 8-) David -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42325 --- Comment #6 from jonadab.theunsightlyone@gmail.com <jonadab.theunsightlyone@gmail.com> --- Ah, good info, thanks. I will start looking over it tonight or tomorrow. I'm not yet at the point of being familiar enough with the codebase to make more substantial contributions, but the main point of this exercise for me is to try to _get_ to that point, so I don't mind investing a bit of time learning the ropes. There's a bit of flexibility in the definition of who exactly is a "developer" or not (writing program code is not the only possible form of developer contribution); but yes, this patch should ideally be reviewed by someone with at least a basic understanding of Perl. I think it's very low-risk (the error message in question isn't end-user-facing; it's the sort of thing that might show up e.g. in an Apache error log), but I am a total novice with this codebase, and this is my first contribution of any kind to the project, so my judgement should not be relied upon; someone with at least basic knowledge of the code should check it. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42325 --- Comment #7 from David Nind <david@davidnind.com> --- Excellent. A good way to start is to get KTD running, and then start with signing off bugs. You can get a list from the dashboard, https://dashboard.koha-community.org/ Another good resource is the koha-US Baby Devs Special Interest Group (although the meeting for this month was today, I missed it) https://koha-us.org/special-interest-groups/ Happy to help! David -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42325 Aude Charillon <aude.charillon@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- CC|aude.charillon@openfifth.co | |.uk | -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon@bugs.koha-community.org