From 5a6087c919432fcf06a4ab84babbf0d1fb3975b3 Mon Sep 17 00:00:00 2001 From: Jesse Hernandez Date: Mon, 6 Jan 2025 10:06:18 -0800 Subject: [PATCH] docs: adding .gitignore, pr template, yaml lint --- .github/pr_template.yml | 6 ++++++ .github/workflows/yaml_lint.yml | 21 +++++++++++++++++++++ .gitignore | 5 +++++ .yamllint.yaml | 11 +++++++++++ 4 files changed, 43 insertions(+) create mode 100644 .github/pr_template.yml create mode 100644 .github/workflows/yaml_lint.yml create mode 100644 .gitignore create mode 100644 .yamllint.yaml diff --git a/.github/pr_template.yml b/.github/pr_template.yml new file mode 100644 index 0000000..b33a357 --- /dev/null +++ b/.github/pr_template.yml @@ -0,0 +1,6 @@ +### Description +Provide the reason of this PR. + +- [ ] Did you squash your commits? `git reset --soft HEAD~3` where 3 is the number of commits you want to squash. +- [ ] Did you sign the CLA? https://gist.github.com/jamespilgrim/e6996a438adc0919ebbe70561efbb600#file-verdant-contributor-license-agreement-md. +- [ ] Did you run build locally and ran successfully? \ No newline at end of file diff --git a/.github/workflows/yaml_lint.yml b/.github/workflows/yaml_lint.yml new file mode 100644 index 0000000..6ca22e3 --- /dev/null +++ b/.github/workflows/yaml_lint.yml @@ -0,0 +1,21 @@ +--- +name: YAML Lint + +on: + push: + paths: + - '.github/workflows/**.yaml' + - '.github/workflows/**.yml' + - '!docs/**' + +jobs: + golangci: + name: YAML Lint + runs-on: [ubuntu-latest] + steps: + - uses: actions/checkout@v3 + - name: yaml-lint + uses: ibiqlik/action-yamllint@v3 + with: + file_or_dir: .github/workflows + config_file: .yamllint.yaml \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..10bbcf7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Visual Code +# Ignoring root .vscode folder. +.vscode/ +# Ignoring ~/build inside LMSourceCode +/Software/LMSourceCode/ImageProcessing/build \ No newline at end of file diff --git a/.yamllint.yaml b/.yamllint.yaml new file mode 100644 index 0000000..15cd2c0 --- /dev/null +++ b/.yamllint.yaml @@ -0,0 +1,11 @@ +--- +extends: default + +rules: + line-length: disable + new-lines: + type: unix + new-line-at-end-of-file: + level: warning + trailing-spaces: + level: warning \ No newline at end of file