From 842e4177024954da0ca428928a652b3d5e722267 Mon Sep 17 00:00:00 2001 From: James Cobb Date: Thu, 7 Oct 2021 09:56:03 -0500 Subject: [PATCH] addlint and pr template --- .github/pull_request_template.md | 47 ++++++++++++++++++++++++++++ .github/workflows/lint.yml | 53 ++++++++++++++++++++++++++++++++ 2 files changed, 100 insertions(+) create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/lint.yml diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..12a9bb0 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,47 @@ + + + + +# Summary + + + +# Why This Is Needed + + + +# What Changed + + + +## Added + + + +## Changed + + + +## Fixed + + + +## Removed + + + +# Screenshots + + + +# Checklist + + +- [ ] Have you followed the guidelines in our Contributing document? +- [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? +- [ ] Does your submission pass tests? +- [ ] Have you linted your code locally prior to submission? +- [ ] Have you added an explanation of what your changes do and why you'd like us to include them? +- [ ] Have you written new tests for your core changes, as applicable? +- [ ] Have you successfully ran tests with your changes locally? +- [ ] Have you updated documentation, as applicable? \ No newline at end of file diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..0f4a8c4 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,53 @@ +--- +################################# +################################# +## Super Linter GitHub Actions ## +################################# +################################# +name: Lint Code Base + +# +# Documentation: +# https://help.github.com/en/articles/workflow-syntax-for-github-actions +# + +############################# +# Start the job on all push # +############################# +on: + push: + branches-ignore: [beta, main] + # Remove the line above to run when pushing to master + +############### +# Set the Job # +############### +jobs: + build: + # Name the Job + name: Lint Code Base + # Set the agent to run on + runs-on: ubuntu-latest + + ################## + # Load all steps # + ################## + steps: + ########################## + # Checkout the code base # + ########################## + - name: Checkout Code + uses: actions/checkout@v2 + with: + # Full git history is needed to get a proper list of changed files within `super-linter` + fetch-depth: 0 + + ################################ + # Run Linter against code base # + ################################ + - name: Lint Code Base + uses: github/super-linter/slim@v4 + env: + VALIDATE_ALL_CODEBASE: false + VALIDATE_JSON: true + DEFAULT_BRANCH: main \ No newline at end of file