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

Setup pre-commit for GEF #984

Merged
merged 11 commits into from
Aug 7, 2023
Merged

Setup pre-commit for GEF #984

merged 11 commits into from
Aug 7, 2023

Conversation

hugsy
Copy link
Owner

@hugsy hugsy commented Aug 7, 2023

Description/Motivation/Screenshots

This PR adds pre-commit to facilitate and unify the formatting of everything in this project (code, test, docs, ci).

Aside from .pre-commit-config.yml and docs/.markdownlint.yaml, all the other changes are purely cosmetic, applying markdownlint and fixing here and there to make it pass.

It also creates a new CI job that'll simply execute pre-commit for new PRs.

Against which architecture was this tested ?

"Tested" indicates that the PR works and the unit test (see docs/testing.md) run passes without issue.

N/A

Checklist

  • My code follows the code style of this project.
  • My change includes a change to the documentation, if required.
  • If my change adds new code, adequate tests have been added.
  • I have read and agree to the CONTRIBUTING document.

@github-actions
Copy link

github-actions bot commented Aug 7, 2023

🤖 Coverage Update

  • Commit: 175ccf2
  • Current Coverage: 71.5684%
  • New Coverage: 71.5585%
  • Diff: -0.009900000000001796

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
@hugsy hugsy requested a review from therealdreg August 7, 2023 18:35
@github-actions
Copy link

github-actions bot commented Aug 7, 2023

🤖 Coverage Update

  • Commit: c3130db
  • Current Coverage: 71.5585%
  • New Coverage: 71.5585%
  • Diff: 0.0

To this point, this PR:

  • does not include changes to tests
  • does not include changes to documentation

@hugsy hugsy merged commit 7c170cf into main Aug 7, 2023
5 checks passed
@hugsy hugsy deleted the use_pre_commit branch August 7, 2023 23:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants