pre-commit hooks & conventions

.editorconfig

@@ -8,7 +8,7 @@ tab_width = 4
 
 # New line preferences
 end_of_line = lf
-insert_final_newline = false
+insert_final_newline = true
 
 charset = utf-8
-trim_trailing_whitespace = true
+trim_trailing_whitespace = true

.gitattributes

@@ -1,11 +1,11 @@
 # Standard to msysgit
-*.doc	 diff=astextplain
-*.DOC	 diff=astextplain
+*.doc    diff=astextplain
+*.DOC    diff=astextplain
 *.docx diff=astextplain
 *.DOCX diff=astextplain
 *.dot  diff=astextplain
 *.DOT  diff=astextplain
 *.pdf  diff=astextplain
-*.PDF	 diff=astextplain
-*.rtf	 diff=astextplain
-*.RTF	 diff=astextplain
+*.PDF    diff=astextplain
+*.rtf    diff=astextplain
+*.RTF    diff=astextplain

.github/CONTRIBUTING.md

@@ -1,3 +1,13 @@
 # Contributing Guide
 We're open for Pull Requests.
-Our endgoal is to bond every community out there so we'd love to get in touch with you and partake in discussions on either [Issues](https://github.com/UltraStar-Deluxe/format/issues), [PR's](https://github.com/UltraStar-Deluxe/format/pulls) or [Discord - Format Related channel](https://discord.gg/tNEXZw2QJX)
+Our endgoal is to bond every community out there so we'd love to get in touch with you and partake in discussions on either [Issues](https://github.com/UltraStar-Deluxe/format/issues), [PR's](https://github.com/UltraStar-Deluxe/format/pulls) or [Discord - Format Related channel](https://discord.gg/tNEXZw2QJX)
+
+## Setup your IDE
+If you want to contribute please setup your IDE or Editor correctly.
+To do this you'll have to make sure the Editorconfig is used (works per default in VSCode) and that you have `pre-commit` installed so your commits are checked before pushing.
+
+### Install & configure pre-commit (through python)
+Please execute the following commands within the repositories root directory.
+This will install pre-commit to your system and installs the git hooks which check your changed code on commit if your changes adhere the conventions.
+1. `pip install pre-commit`
+2. `pre-commit install`

.github/ISSUE_TEMPLATE/bug_report.yml → .github/ISSUE_TEMPLATE/bug_report.yaml

@@ -37,4 +37,4 @@ body:
       label: Additional context
       description: Add screenshots etc. (Anything that will provide more context about the problem)
     validations:
-      required: false
+      required: false

.github/ISSUE_TEMPLATE/config.yml → .github/ISSUE_TEMPLATE/config.yaml

@@ -11,4 +11,4 @@ contact_links:
 
   - name: Question
     url: "https://discord.gg/NS3m3ad"
-    about: "Please ask questions in our Discord in the channel format-related"
+    about: "Please ask questions in our Discord in the channel format-related"

.github/ISSUE_TEMPLATE/feature_request.yml → .github/ISSUE_TEMPLATE/feature_request.yaml

@@ -32,4 +32,4 @@ body:
       label: Extra info/examples/attachments
       description: Add screenshots etc. (Anything that will give us more context about what is being requested!)
     validations:
-      required: false
+      required: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -31,4 +31,4 @@ HOW TO WRITE A GOOD PULL REQUEST?
 
 ### Additional Notes
 
-<!-- Anything else we should know when reviewing? -->
+<!-- Anything else we should know when reviewing? -->

.github/workflows/build_and_release.yml → .github/workflows/build_and_release.yaml

@@ -3,7 +3,7 @@ name: Build and Release UltraStar Format Specification Website
 # Controls when the workflow will run
 on:
   # Triggers the workflow on merges to master, release branches,
-  # all PRs, and release tags 
+  # all PRs, and release tags
   push:
     branches:
       - main
@@ -43,4 +43,3 @@ jobs:
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v2
-

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: check-case-conflict
+    -   id: check-executables-have-shebangs
+    -   id: check-shebang-scripts-are-executable
+    -   id: check-json
+    -   id: check-merge-conflict
+    -   id: check-yaml
+    -   id: fix-byte-order-marker
+    -   id: end-of-file-fixer
+    -   id: mixed-line-ending
+    -   id: pretty-format-json
+    -   id: trailing-whitespace
+- repo: https://github.com/Lucas-C/pre-commit-hooks
+  rev: v1.5.4
+  hooks:
+    - id: forbid-crlf
+    - id: remove-crlf
+    - id: forbid-tabs
+    - id: remove-tabs
+      args: [--whitespaces-count, '4']  # defaults to: 4

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 UltraStar Karaoke 
+Copyright (c) 2023 UltraStar Karaoke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -41,4 +41,4 @@ We'd like to give these projects a little bit of appreciation by linking to thei
 
 ### Management Software
 * [USDB Syncer](https://github.com/bohning/usdb_syncer)
-* [UltraStar Manager](https://github.com/UltraStar-Deluxe/UltraStar-Manager)
+* [UltraStar Manager](https://github.com/UltraStar-Deluxe/UltraStar-Manager)

docs/css/owl.carousel.css

@@ -1,71 +1,70 @@
-/* 
- * 	Core Owl Carousel CSS File
- *	v1.3.3
+/*
+ *  Core Owl Carousel CSS File
+ *  v1.3.3
  */
 
 /* clearfix */
 .owl-carousel .owl-wrapper:after {
-	content: ".";
-	display: block;
-	clear: both;
-	visibility: hidden;
-	line-height: 0;
-	height: 0;
+    content: ".";
+    display: block;
+    clear: both;
+    visibility: hidden;
+    line-height: 0;
+    height: 0;
 }
 /* display none until init */
 .owl-carousel{
-	display: none;
-	position: relative;
-	width: 100%;
-	-ms-touch-action: pan-y;
+    display: none;
+    position: relative;
+    width: 100%;
+    -ms-touch-action: pan-y;
 }
 .owl-carousel .owl-wrapper{
-	display: none;
-	position: relative;
-	-webkit-transform: translate3d(0px, 0px, 0px);
+    display: none;
+    position: relative;
+    -webkit-transform: translate3d(0px, 0px, 0px);
 }
 .owl-carousel .owl-wrapper-outer{
-	overflow: hidden;
-	position: relative;
-	width: 100%;
+    overflow: hidden;
+    position: relative;
+    width: 100%;
 }
 .owl-carousel .owl-wrapper-outer.autoHeight{
-	-webkit-transition: height 500ms ease-in-out;
-	-moz-transition: height 500ms ease-in-out;
-	-ms-transition: height 500ms ease-in-out;
-	-o-transition: height 500ms ease-in-out;
-	transition: height 500ms ease-in-out;
+    -webkit-transition: height 500ms ease-in-out;
+    -moz-transition: height 500ms ease-in-out;
+    -ms-transition: height 500ms ease-in-out;
+    -o-transition: height 500ms ease-in-out;
+    transition: height 500ms ease-in-out;
 }
-	
+
 .owl-carousel .owl-item{
-	float: left;
+    float: left;
 }
 .owl-controls .owl-page,
 .owl-controls .owl-buttons div{
-	cursor: pointer;
+    cursor: pointer;
 }
 .owl-controls {
-	-webkit-user-select: none;
-	-khtml-user-select: none;
-	-moz-user-select: none;
-	-ms-user-select: none;
-	user-select: none;
-	-webkit-tap-highlight-color: rgba(0, 0, 0, 0);
+    -webkit-user-select: none;
+    -khtml-user-select: none;
+    -moz-user-select: none;
+    -ms-user-select: none;
+    user-select: none;
+    -webkit-tap-highlight-color: rgba(0, 0, 0, 0);
 }
 
 /* mouse grab icon */
-.grabbing { 
+.grabbing {
     cursor:url(grabbing.png) 8 8, move;
 }
 
 /* fix */
 .owl-carousel  .owl-wrapper,
 .owl-carousel  .owl-item{
-	-webkit-backface-visibility: hidden;
-	-moz-backface-visibility:    hidden;
-	-ms-backface-visibility:     hidden;
+    -webkit-backface-visibility: hidden;
+    -moz-backface-visibility:    hidden;
+    -ms-backface-visibility:     hidden;
   -webkit-transform: translate3d(0,0,0);
   -moz-transform: translate3d(0,0,0);
   -ms-transform: translate3d(0,0,0);
 }
-

docs/css/owl.theme.css

@@ -1,79 +1,79 @@
 /*
-* 	Owl Carousel Owl Demo Theme 
-*	v1.3.3
+*   Owl Carousel Owl Demo Theme
+*   v1.3.3
 */
 
 .owl-theme .owl-controls{
-	margin-top: 10px;
-	text-align: center;
+    margin-top: 10px;
+    text-align: center;
 }
 
 /* Styling Next and Prev buttons */
 
 .owl-theme .owl-controls .owl-buttons div{
-	color: #FFF;
-	display: inline-block;
-	zoom: 1;
-	*display: inline;/*IE7 life-saver */
-	margin: 5px;
-	padding: 3px 10px;
-	font-size: 12px;
-	-webkit-border-radius: 30px;
-	-moz-border-radius: 30px;
-	border-radius: 30px;
-	background: #869791;
-	filter: Alpha(Opacity=50);/*IE7 fix*/
-	opacity: 0.5;
+    color: #FFF;
+    display: inline-block;
+    zoom: 1;
+    *display: inline;/*IE7 life-saver */
+    margin: 5px;
+    padding: 3px 10px;
+    font-size: 12px;
+    -webkit-border-radius: 30px;
+    -moz-border-radius: 30px;
+    border-radius: 30px;
+    background: #869791;
+    filter: Alpha(Opacity=50);/*IE7 fix*/
+    opacity: 0.5;
 }
 /* Clickable class fix problem with hover on touch devices */
 /* Use it for non-touch hover action */
 .owl-theme .owl-controls.clickable .owl-buttons div:hover{
-	filter: Alpha(Opacity=100);/*IE7 fix*/
-	opacity: 1;
-	text-decoration: none;
+    filter: Alpha(Opacity=100);/*IE7 fix*/
+    opacity: 1;
+    text-decoration: none;
 }
 
 /* Styling Pagination*/
 
 .owl-theme .owl-controls .owl-page{
-	display: inline-block;
-	zoom: 1;
-	*display: inline;/*IE7 life-saver */
+    display: inline-block;
+    zoom: 1;
+    *display: inline;/*IE7 life-saver */
 }
 .owl-theme .owl-controls .owl-page span{
-	display: block;
-	width: 12px;
-	height: 12px;
-	margin: 5px 7px;
-	filter: Alpha(Opacity=50);/*IE7 fix*/
-	opacity: 0.5;
-	-webkit-border-radius: 20px;
-	-moz-border-radius: 20px;
-	border-radius: 20px;
-	background: #869791;
+    display: block;
+    width: 12px;
+    height: 12px;
+    margin: 5px 7px;
+    filter: Alpha(Opacity=50);/*IE7 fix*/
+    opacity: 0.5;
+    -webkit-border-radius: 20px;
+    -moz-border-radius: 20px;
+    border-radius: 20px;
+    background: #869791;
 }
 
 .owl-theme .owl-controls .owl-page.active span,
 .owl-theme .owl-controls.clickable .owl-page:hover span{
-	filter: Alpha(Opacity=100);/*IE7 fix*/
-	opacity: 1;
+    filter: Alpha(Opacity=100);/*IE7 fix*/
+    opacity: 1;
 }
 
 /* If PaginationNumbers is true */
 
 .owl-theme .owl-controls .owl-page span.owl-numbers{
-	height: auto;
-	width: auto;
-	color: #FFF;
-	padding: 2px 10px;
-	font-size: 12px;
-	-webkit-border-radius: 30px;
-	-moz-border-radius: 30px;
-	border-radius: 30px;
+    height: auto;
+    width: auto;
+    color: #FFF;
+    padding: 2px 10px;
+    font-size: 12px;
+    -webkit-border-radius: 30px;
+    -moz-border-radius: 30px;
+    border-radius: 30px;
 }
 
 /* preloading images */
 .owl-item.loading{
-	min-height: 150px;
-	background: url(AjaxLoader.gif) no-repeat center center
-}
+    min-height: 150px;
+    background: url(AjaxLoader.gif) no-repeat center center
+}