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

🎨🚨 Improved formatting and linting config #625

Merged
merged 8 commits into from
Jun 5, 2024

Conversation

burgholzer
Copy link
Member

Description

This PR adds a couple further pre-commit checks and other utilities to ensure the validity of certain configs.
This includes:

  • a pre-commit check for checking several schemata for their correctness, such as dependabot and GitHub actions
  • an .editorconfig file for enabling wide spread support for proper formatting out of the box
  • a switch from codespell to the typos spellchecker that is more comprehensive and a lot faster
  • a validate-pyproject check that makes sure the pyproject.toml is valid

Checklist:

  • The pull request only contains commits that are related to it.
  • I have added appropriate tests and documentation.
  • I have made sure that all CI jobs on GitHub pass.
  • The pull request introduces no new warnings and follows the project's style guidelines.

@burgholzer burgholzer added dependencies Pull requests that update a dependency file code quality Code quality improvements continuous integration Anything related to the CI setup labels Jun 5, 2024
@burgholzer burgholzer self-assigned this Jun 5, 2024
Copy link

codecov bot commented Jun 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.6%. Comparing base (86d93b5) to head (178669d).
Report is 97 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main    #625   +/-   ##
=====================================
  Coverage   91.6%   91.6%           
=====================================
  Files        148     148           
  Lines      14736   14738    +2     
  Branches    2365    2365           
=====================================
+ Hits       13504   13507    +3     
+ Misses      1232    1231    -1     
Flag Coverage Δ
cpp 91.4% <100.0%> (+<0.1%) ⬆️
python 99.7% <100.0%> (ø)
Files with missing lines Coverage Δ
include/mqt-core/QuantumComputation.hpp 92.3% <100.0%> (ø)
include/mqt-core/dd/Package.hpp 97.6% <100.0%> (+<0.1%) ⬆️
include/mqt-core/na/NADefinitions.hpp 98.0% <100.0%> (ø)
...mqt-core/operations/ClassicControlledOperation.hpp 96.6% <ø> (ø)
src/QuantumComputation.cpp 82.6% <100.0%> (ø)
src/mqt/core/plugins/qiskit.py 100.0% <100.0%> (ø)
src/operations/ClassicControlledOperation.cpp 88.5% <100.0%> (ø)
src/parsers/QASM3Parser.cpp 90.5% <100.0%> (ø)
src/zx/ZXDiagram.cpp 92.3% <100.0%> (ø)

... and 1 file with indirect coverage changes

@burgholzer burgholzer merged commit 99c8901 into main Jun 5, 2024
34 checks passed
@burgholzer burgholzer deleted the improved-formatting-and-linting branch June 5, 2024 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality Code quality improvements continuous integration Anything related to the CI setup dependencies Pull requests that update a dependency file
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant