Skip to content

Commit

Permalink
docs: adding .gitignore, pr template, yaml lint
Browse files Browse the repository at this point in the history
  • Loading branch information
jeshernandez committed Jan 6, 2025
1 parent be5da6a commit 5a6087c
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .github/pr_template.yml
Original file line number Diff line number Diff line change
@@ -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?
21 changes: 21 additions & 0 deletions .github/workflows/yaml_lint.yml
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Visual Code
# Ignoring root .vscode folder.
.vscode/
# Ignoring ~/build inside LMSourceCode
/Software/LMSourceCode/ImageProcessing/build
11 changes: 11 additions & 0 deletions .yamllint.yaml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 5a6087c

Please sign in to comment.