Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pre-commit hooks and linting check on PR #46

Merged
merged 1 commit into from
Jul 13, 2024
Merged

Conversation

johnlk
Copy link
Contributor

@johnlk johnlk commented Jul 13, 2024

Changes Made

  • Added bash linting rules
  • Added comment linting rules
    • fixed a bunch of missing new lines at EOF
  • Rules backed up by GH action check

@johnlk johnlk self-assigned this Jul 13, 2024
Copy link

Score: 80

Improvements:

  • Ensure consistency by adding newlines at the end of files.
  • Consider using a single method for installing dependencies in CI and Dockerfile to avoid inconsistencies.
  • Group related steps in CI for better readability and maintainability.
  • Add comments where necessary to explain non-obvious steps, especially in scripts handling complex logic.
# Example of grouping related CI steps for better readability
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Setup and Run Linting
        run: |
          sudo apt-get install -y shellcheck
          shellcheck **/*.sh

@johnlk johnlk merged commit 4027002 into main Jul 13, 2024
3 checks passed
@johnlk johnlk deleted the john/add-pre-commit branch July 13, 2024 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant