[Bug 12545] New: Add EditorConfig file to the source tree
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12545 Bug ID: 12545 Summary: Add EditorConfig file to the source tree Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Developer documentation Assignee: gmcharlt@gmail.com Reporter: tomascohen@gmail.com QA Contact: testopia@bugs.koha-community.org It'd be usefull to have a .editorconfig [1] file, that enforces some of our coding guidelines, in the source tree top level. Those developers that have their editors configured to honour the file, will benefit. Those that wouldn't use it, won't get bothered by the addition. So, a harmless addition that would benefit those that are interested. There are plugins for several major editors: - Emacs - Vim - SublimeText - and so on... [1] http://editorconfig.org/ -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12545 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|gmcharlt@gmail.com |tomascohen@gmail.com -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12545 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12545 --- Comment #1 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 29587 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=29587&action=edit Bug 12545: Add EditorConfig.org file to the source tree This patch adds a .editorconfig file to the source tree, that enforces some of our coding guidelines. Some editors try to detect the desired configurations from the currently opened file. As we have tons of old code that doesn't follow our current coding guidelines, this can lead to unintended QA problmes. To test: - Apply the patch - Verify the .editorconfig file is in the top-level directory - See the .editorconfig file expresses our coding guidelines Regards To+ -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12545 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |dcook@prosentient.com.au --- Comment #2 from David Cook <dcook@prosentient.com.au> --- I saw that there is a Notepad++ plugin (which is what I usually use), so I'd be keen to try this out sometime... -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12545 --- Comment #3 from Tomás Cohen Arazi <tomascohen@gmail.com> --- (In reply to David Cook from comment #2)
I saw that there is a Notepad++ plugin (which is what I usually use), so I'd be keen to try this out sometime...
There is, indeed a plugin for it. The key idea is that if anyone works on different projects with different coding guidelines, the Koha-specific config is confined to the project. Also, for people starting, we could add it (installing the necesary plugin) to the list of steps to setup the dev environment. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12545 Chris Cormack <chris@bigballofwax.co.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12545 Chris Cormack <chris@bigballofwax.co.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #29587|0 |1 is obsolete| | --- Comment #4 from Chris Cormack <chris@bigballofwax.co.nz> --- Created attachment 30263 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=30263&action=edit Bug 12545: Add EditorConfig.org file to the source tree This patch adds a .editorconfig file to the source tree, that enforces some of our coding guidelines. Some editors try to detect the desired configurations from the currently opened file. As we have tons of old code that doesn't follow our current coding guidelines, this can lead to unintended QA problmes. To test: - Apply the patch - Verify the .editorconfig file is in the top-level directory - See the .editorconfig file expresses our coding guidelines Regards To+ Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz> -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12545 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |katrin.fischer@bsz-bw.de Patch complexity|--- |Small patch -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12545 Jonathan Druart <jonathan.druart@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12545 Jonathan Druart <jonathan.druart@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #30263|0 |1 is obsolete| | --- Comment #5 from Jonathan Druart <jonathan.druart@biblibre.com> --- Created attachment 31070 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=31070&action=edit Bug 12545: Add EditorConfig.org file to the source tree This patch adds a .editorconfig file to the source tree, that enforces some of our coding guidelines. Some editors try to detect the desired configurations from the currently opened file. As we have tons of old code that doesn't follow our current coding guidelines, this can lead to unintended QA problmes. To test: - Apply the patch - Verify the .editorconfig file is in the top-level directory - See the .editorconfig file expresses our coding guidelines Regards To+ Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz> Signed-off-by: Jonathan Druart <jonathan.druart@biblibre.com> -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12545 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Pushed to Master --- Comment #6 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Patch pushed to master. -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon@bugs.koha-community.org