Summary: | Add EditorConfig file to the source tree | ||
---|---|---|---|
Product: | Koha | Reporter: | Tomás Cohen Arazi (tcohen) <tomascohen> |
Component: | Developer documentation | Assignee: | Tomás Cohen Arazi (tcohen) <tomascohen> |
Status: | CLOSED FIXED | QA Contact: | Testopia <testopia> |
Severity: | enhancement | ||
Priority: | P5 - low | CC: | dcook |
Version: | Main | ||
Hardware: | All | ||
OS: | All | ||
Change sponsored?: | --- | Patch complexity: | Small patch |
Documentation contact: | Documentation submission: | ||
Text to go in the release notes: | Version(s) released in: | ||
Circulation function: | |||
Bug Depends on: | |||
Bug Blocks: | 24774, 33358 | ||
Attachments: |
Bug 12545: Add EditorConfig.org file to the source tree
Bug 12545: Add EditorConfig.org file to the source tree Bug 12545: Add EditorConfig.org file to the source tree |
Description
Tomás Cohen Arazi (tcohen)
2014-07-09 14:18:58 UTC
Created attachment 29587 [details] [review] 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+ I saw that there is a Notepad++ plugin (which is what I usually use), so I'd be keen to try this out sometime... (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. Created attachment 30263 [details] [review] 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> Created attachment 31070 [details] [review] 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> Patch pushed to master. |