Feature/add linter configuration file #120
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes
Description
This pull request adds a Super Linter configuration to the project to enhance code quality and maintainability. The linter will automatically check the HTML and CSS files for style and syntax issues, ensuring consistent coding standards across the codebase.
Key Changes:
Introduced linter.yml configuration file for Super Linter.
Configured the linter to validate HTML and CSS files.
Set up GitHub Actions to run the linter on pull requests and pushes, except on the master and main branches.
By integrating this linter, we aim to reduce code review times and improve overall code quality by catching style and syntax errors automatically.
Tests
1)Check the Linter Configuration:
Review the linter.yml file located in the .github/workflows/ directory to ensure it contains the correct settings for linting HTML and CSS files.
Create a Test Pull Request:
2) Create a new branch with a small HTML or CSS file that intentionally contains a style or syntax error (e.g., missing semicolon, incorrect nesting).
Push the branch to the remote repository and create a pull request to trigger the Super Linter.
Review GitHub Actions Output:
3)Navigate to the Actions tab of the repository and select the workflow run triggered by the pull request.
Verify that the Super Linter job completes successfully and correctly identifies any errors or warnings in the test files.
4)Check for Automatic Fixes:
If applicable, test running the linter with the --fix option locally to ensure it can automatically correct linting issues:
Checklist
Update index.md
).main
ormaster
).visible errors.
Developer Certificate of Origin
For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."
Developer Certificate of Origin