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

Feature/add linter configuration file #120

Conversation

solonkonora
Copy link

@solonkonora solonkonora commented Oct 7, 2024

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

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    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
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

…ecking and formatting code to ensure it follows the best practices
…y runs a linter on the codebase every time a push is made (except to master/main) or a pull request is opened targeting master/main. It uses GitHub's Super Linter, which checks for code quality and helps maintain consistency and avoid errors in the project
@solonkonora solonkonora requested review from a team as code owners October 7, 2024 10:56
@solonkonora solonkonora requested review from TimidRobot, possumbilities, Dhruvi16 and nimishbongale and removed request for a team October 7, 2024 10:56
Copy link

netlify bot commented Oct 7, 2024

Deploy Preview for vocabulary-docs ready!

Name Link
🔨 Latest commit 3ef1ad4
🔍 Latest deploy log https://app.netlify.com/sites/vocabulary-docs/deploys/6703be57b9215b0008445a20
😎 Deploy Preview https://deploy-preview-120--vocabulary-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@possumbilities
Copy link
Contributor

Closing this as the Issue connected is listed as status: blocked

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[Feature] <Add Linter Configuration to the Project>
2 participants