We need Koha Naming Standards
It's been discussed a few times, but I think we need to formalize naming conventions when writing patches for Koha. The worse offenders are those things that we use many different names for both internally and externally. I think patrons/borrowers/members is the worst offender. List come to mind as well ( previously being virtual shelves ). I believe that our internal nomenclature should reflect our outward nomenclature. So if the staff and/or OPAC use the term "patron" we should be using the term "patron" in our code as well, especially for namespaces. What does everyone think? The more we hammer out now the easier it will be to vote on naming rules at the dev meeting. Kyle http://www.kylehall.info ByWater Solutions ( http://bywatersolutions.com ) Meadville Public Library ( http://www.meadvillelibrary.org ) Crawford County Federated Library System ( http://www.ccfls.org ) Mill Run Technology Solutions ( http://millruntech.com )
On Fri, Jun 19, 2015 at 10:35 AM, Kyle Hall <kyle.m.hall@gmail.com> wrote:
It's been discussed a few times, but I think we need to formalize naming conventions when writing patches for Koha.
The worse offenders are those things that we use many different names for both internally and externally. I think patrons/borrowers/members is the worst offender. List come to mind as well ( previously being virtual shelves ).
I believe that our internal nomenclature should reflect our outward nomenclature. So if the staff and/or OPAC use the term "patron" we should be using the term "patron" in our code as well, especially for namespaces.
What does everyone think?
+1 Kind Regards, Chris
I have created a page on the wiki for the terminology: http://wiki.koha-community.org/wiki/Terminology IMO what we need, most of all, is a consensus on how we want to see the Koha namespace organised. 2015-06-19 15:35 GMT+01:00 Kyle Hall <kyle.m.hall@gmail.com>:
It's been discussed a few times, but I think we need to formalize naming conventions when writing patches for Koha.
The worse offenders are those things that we use many different names for both internally and externally. I think patrons/borrowers/members is the worst offender. List come to mind as well ( previously being virtual shelves ).
I believe that our internal nomenclature should reflect our outward nomenclature. So if the staff and/or OPAC use the term "patron" we should be using the term "patron" in our code as well, especially for namespaces.
What does everyone think?
The more we hammer out now the easier it will be to vote on naming rules at the dev meeting.
Kyle
http://www.kylehall.info ByWater Solutions ( http://bywatersolutions.com ) Meadville Public Library ( http://www.meadvillelibrary.org ) Crawford County Federated Library System ( http://www.ccfls.org ) Mill Run Technology Solutions ( http://millruntech.com )
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
Excellent list Jonathan! I think You've summed up most if not all the terms that need clarifying. The only one I could possibly add is Lists, but I don't think anyone has called them virtual shelves in ages. Kyle http://www.kylehall.info ByWater Solutions ( http://bywatersolutions.com ) Meadville Public Library ( http://www.meadvillelibrary.org ) Crawford County Federated Library System ( http://www.ccfls.org ) Mill Run Technology Solutions ( http://millruntech.com ) On Fri, Jun 19, 2015 at 10:42 AM, Jonathan Druart < jonathan.druart@biblibre.com> wrote:
I have created a page on the wiki for the terminology: http://wiki.koha-community.org/wiki/Terminology
IMO what we need, most of all, is a consensus on how we want to see the Koha namespace organised.
2015-06-19 15:35 GMT+01:00 Kyle Hall <kyle.m.hall@gmail.com>:
It's been discussed a few times, but I think we need to formalize naming conventions when writing patches for Koha.
The worse offenders are those things that we use many different names for both internally and externally. I think patrons/borrowers/members is the worst offender. List come to mind as well ( previously being virtual shelves ).
I believe that our internal nomenclature should reflect our outward nomenclature. So if the staff and/or OPAC use the term "patron" we should be using the term "patron" in our code as well, especially for namespaces.
What does everyone think?
The more we hammer out now the easier it will be to vote on naming rules at the dev meeting.
Kyle
http://www.kylehall.info ByWater Solutions ( http://bywatersolutions.com ) Meadville Public Library ( http://www.meadvillelibrary.org ) Crawford County Federated Library System ( http://www.ccfls.org ) Mill Run Technology Solutions ( http://millruntech.com )
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
I've gone ahead and added them anyway, since we still have opac-shelves.pl and C4:VirtualShelves hanging around. 2015-06-22 8:28 GMT-06:00 Kyle Hall <kyle.m.hall@gmail.com>:
Excellent list Jonathan! I think You've summed up most if not all the terms that need clarifying. The only one I could possibly add is Lists, but I don't think anyone has called them virtual shelves in ages.
Kyle
http://www.kylehall.info ByWater Solutions ( http://bywatersolutions.com ) Meadville Public Library ( http://www.meadvillelibrary.org ) Crawford County Federated Library System ( http://www.ccfls.org ) Mill Run Technology Solutions ( http://millruntech.com )
On Fri, Jun 19, 2015 at 10:42 AM, Jonathan Druart < jonathan.druart@biblibre.com> wrote:
I have created a page on the wiki for the terminology: http://wiki.koha-community.org/wiki/Terminology
IMO what we need, most of all, is a consensus on how we want to see the Koha namespace organised.
2015-06-19 15:35 GMT+01:00 Kyle Hall <kyle.m.hall@gmail.com>:
It's been discussed a few times, but I think we need to formalize naming conventions when writing patches for Koha.
The worse offenders are those things that we use many different names for both internally and externally. I think patrons/borrowers/members is the worst offender. List come to mind as well ( previously being virtual shelves ).
I believe that our internal nomenclature should reflect our outward nomenclature. So if the staff and/or OPAC use the term "patron" we should be using the term "patron" in our code as well, especially for namespaces.
What does everyone think?
The more we hammer out now the easier it will be to vote on naming rules at the dev meeting.
Kyle
http://www.kylehall.info ByWater Solutions ( http://bywatersolutions.com ) Meadville Public Library ( http://www.meadvillelibrary.org ) Crawford County Federated Library System ( http://www.ccfls.org ) Mill Run Technology Solutions ( http://millruntech.com )
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
-- Jesse Weaver
The discussion started from bug 12598 comment 44. For instance, do we want Koha::Patron::Import or Koha::Import::Patron? 2015-06-19 15:35 GMT+01:00 Kyle Hall <kyle.m.hall@gmail.com>:
It's been discussed a few times, but I think we need to formalize naming conventions when writing patches for Koha.
The worse offenders are those things that we use many different names for both internally and externally. I think patrons/borrowers/members is the worst offender. List come to mind as well ( previously being virtual shelves ).
I believe that our internal nomenclature should reflect our outward nomenclature. So if the staff and/or OPAC use the term "patron" we should be using the term "patron" in our code as well, especially for namespaces.
What does everyone think?
The more we hammer out now the easier it will be to vote on naming rules at the dev meeting.
Kyle
http://www.kylehall.info ByWater Solutions ( http://bywatersolutions.com ) Meadville Public Library ( http://www.meadvillelibrary.org ) Crawford County Federated Library System ( http://www.ccfls.org ) Mill Run Technology Solutions ( http://millruntech.com )
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
Definite +1 to this. Should we also discuss adding this to the coding standards at the next development meeting? 2015-06-19 8:43 GMT-06:00 Jonathan Druart <jonathan.druart@biblibre.com>:
The discussion started from bug 12598 comment 44. For instance, do we want Koha::Patron::Import or Koha::Import::Patron?
2015-06-19 15:35 GMT+01:00 Kyle Hall <kyle.m.hall@gmail.com>:
It's been discussed a few times, but I think we need to formalize naming conventions when writing patches for Koha.
The worse offenders are those things that we use many different names for both internally and externally. I think patrons/borrowers/members is the worst offender. List come to mind as well ( previously being virtual shelves ).
I believe that our internal nomenclature should reflect our outward nomenclature. So if the staff and/or OPAC use the term "patron" we should be using the term "patron" in our code as well, especially for namespaces.
What does everyone think?
The more we hammer out now the easier it will be to vote on naming rules at the dev meeting.
Kyle
http://www.kylehall.info ByWater Solutions ( http://bywatersolutions.com ) Meadville Public Library ( http://www.meadvillelibrary.org ) Crawford County Federated Library System ( http://www.ccfls.org ) Mill Run Technology Solutions ( http://millruntech.com )
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
-- Jesse Weaver
On Fri, Jun 19, 2015 at 8:47 PM, Jesse <pianohacker@gmail.com> wrote:
Definite +1 to this.
Should we also discuss adding this to the coding standards at the next development meeting?
+1 this needs to get on the agenda IMHO cheers -idg -- Indranil Das Gupta Phone : +91-98300-20971 Blog : http://indradg.randomink.org/blog IRC : indradg on irc://irc.freenode.net Twitter : indradg -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=- Please exchange editable Office documents only in ODF Format. No other format is acceptable. Support Open Standards. For a free editor supporting ODF, please visit LibreOffice - http://www.documentfoundation.org
I'm new to this game, but what I do know is that having and keeping to standards makes life so much easier. Wendy Sharkey, Cataloger Bennington Free Library 101 Silver Street Bennington VT 05201 From: Indranil Das Gupta <indradg@gmail.com> To: Jesse <pianohacker@gmail.com> Cc: Koha Devel <koha-devel@lists.koha-community.org> Sent: Friday, June 19, 2015 11:28 PM Subject: Re: [Koha-devel] We need Koha Naming Standards On Fri, Jun 19, 2015 at 8:47 PM, Jesse <pianohacker@gmail.com> wrote:
Definite +1 to this.
Should we also discuss adding this to the coding standards at the next development meeting?
+1 this needs to get on the agenda IMHO cheers -idg -- Indranil Das Gupta Phone : +91-98300-20971 Blog : http://indradg.randomink.org/blog IRC : indradg on irc://irc.freenode.net Twitter : indradg -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=- Please exchange editable Office documents only in ODF Format. No other format is acceptable. Support Open Standards. For a free editor supporting ODF, please visit LibreOffice - http://www.documentfoundation.org _______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
+1. Would definitely recommend to a friend. --Barton On Fri, Jun 19, 2015 at 11:17 AM, Jesse <pianohacker@gmail.com> wrote:
Definite +1 to this.
Should we also discuss adding this to the coding standards at the next development meeting?
2015-06-19 8:43 GMT-06:00 Jonathan Druart <jonathan.druart@biblibre.com>:
The discussion started from bug 12598 comment 44. For instance, do we want Koha::Patron::Import or Koha::Import::Patron?
2015-06-19 15:35 GMT+01:00 Kyle Hall <kyle.m.hall@gmail.com>:
It's been discussed a few times, but I think we need to formalize naming conventions when writing patches for Koha.
The worse offenders are those things that we use many different names for both internally and externally. I think patrons/borrowers/members is the worst offender. List come to mind as well ( previously being virtual shelves ).
I believe that our internal nomenclature should reflect our outward nomenclature. So if the staff and/or OPAC use the term "patron" we should be using the term "patron" in our code as well, especially for namespaces.
What does everyone think?
The more we hammer out now the easier it will be to vote on naming rules at the dev meeting.
Kyle
http://www.kylehall.info ByWater Solutions ( http://bywatersolutions.com ) Meadville Public Library ( http://www.meadvillelibrary.org ) Crawford County Federated Library System ( http://www.ccfls.org ) Mill Run Technology Solutions ( http://millruntech.com )
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
-- Jesse Weaver
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
participants (7)
-
Barton Chittenden -
Christopher Nighswonger -
Indranil Das Gupta -
Jesse -
Jonathan Druart -
Kyle Hall -
Wendy Sharkey