Edirom-Online icon indicating copy to clipboard operation
Edirom-Online copied to clipboard

[ftr] Implement Styleguide

Open bwbohl opened this issue 2 years ago • 5 comments

For easier future maintenance and development, we should introduce style guidelines for the different (programming) languages used in Edirom Online:

  • [ ] JavaScript Maybe something by Sencha or https://google.github.io/styleguide/jsguide.html
  • [ ] CSS Recommendation: https://google.github.io/styleguide/htmlcssguide.html
  • [ ] SCSS
  • [ ] XSLT
  • [ ] XQuery Recommendation: http://xqdoc.org/xquery-style.pdf
  • [ ] HTML

bwbohl avatar Jun 13 '23 08:06 bwbohl

For Javascript, I would suggest to use Standard instead (https://standardjs.com/). Bloody simple to set up, and comes with a lot of tools to ensure proper use. Well integrated into editors as well…

kepper avatar Nov 09 '23 12:11 kepper

Many thanks for that valuable contribution!

bwbohl avatar Nov 09 '23 13:11 bwbohl

standardjs apparently also seems to be used by https://github.com/super-linter/super-linter – a tool I would very much like to use in all linting and formatting contexts.

bwbohl avatar Nov 09 '23 13:11 bwbohl

super-linter would cover the following languages that are being used in Edirom Online:

  • CSS
  • HTML
  • XML (--> XSLT?)

Unfortunately, I can't find good or up-to-date XQuery formatters…

bwbohl avatar Nov 09 '23 14:11 bwbohl

as mentioned already in a comment in #227 i would like to see the styleguide in a separate file from CONTRIBUTING.md. at the moment content regarding styleguides is living in CONTRIBUTING.md. I want to support the suggestion from @riedde in #227 to put (only) information how to contribute to this repository into this file.

krHERO avatar Aug 14 '24 12:08 krHERO

closed with https://github.com/Edirom/Edirom-Online/pull/404 of course the file would benefit from more content, but it is a good starting point.

if someone wants to put more work to this topic, i would emphasize the suggestion to create new issues for every single language, that should be added to the styleguide to make it easier to track and review the process. instead of a "list" of content to one issue, that can hardly be reached and even harder reviewed.

krHERO avatar Nov 28 '24 10:11 krHERO