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

Use pre-commit CI to automatically fix code style issues #74

Closed
wants to merge 0 commits into from

Conversation

IamMQaisar
Copy link
Contributor

@IamMQaisar IamMQaisar commented Mar 12, 2024

Fixes

Fixes #68 by @Darylgolden
cc: @TimidRobot

Description

This PR adds a .pre-commit-config.yaml to run the pre-commit hook on the CI for automatically rather than just checking fixing code style issues.

Screenshot

✔ Checking all the Files:
Screenshot (264)

✔ Checking and modifying all the files:
2

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 were 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
    a 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.

@IamMQaisar IamMQaisar requested review from a team as code owners March 12, 2024 18:01
@IamMQaisar IamMQaisar requested review from Shafiya-Heena and possumbilities and removed request for a team March 12, 2024 18:01
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition to the requested changes, please also add documentation to the README.md.

.pre-commit-config.yaml Outdated Show resolved Hide resolved
.pre-commit-config.yaml Outdated Show resolved Hide resolved
@TimidRobot TimidRobot self-assigned this Mar 12, 2024
@IamMQaisar IamMQaisar changed the title Use pre-commit CI to automatically fix code style issues #68 Use pre-commit CI to automatically fix code style issues Mar 13, 2024
@TimidRobot
Copy link
Member

@IamMQaisar there's conflicts now that #71 has been merged:

I like your documentation and would love to see you adapt this PR to the updated main branch.

@IamMQaisar
Copy link
Contributor Author

Sure, I'll adapt to the new PR.

@TimidRobot
Copy link
Member

Sure, I'll adapt to the new PR.

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

Successfully merging this pull request may close these issues.

Use pre-commit CI to automatically fix code style issues
2 participants