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

✨ Add pre-commit configuration #101

Merged
merged 10 commits into from
Sep 5, 2022
Merged

✨ Add pre-commit configuration #101

merged 10 commits into from
Sep 5, 2022

Conversation

burgholzer
Copy link
Member

This PR adds an initial pre-commit configuration to the SyReC project.
Pre-commit is used for ensuring proper formatting across the whole code base and all file types and additionally lints the Python part of the project.

Running it is as easy as

nox -rs lint

nox is best installed via pipx install nox (or brew install nox if you are on macOS). If you don't have pipx (pip for applications) you can install it with pip install pipx (or brew install pipx if you are on macOS).

Most formatting guidelines are applied automatically. For the linter warnings, suggestions are provided in many cases.

This PR also runs pre-commit over the complete code base and applies all suggestions and formatting guidelines.

burgholzer and others added 10 commits September 5, 2022 23:21
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: Lukas Burgholzer <lukas.burgholzer@jku.at>
macOS' runners can now use 3 threads, which should speed builds up a bit.

Signed-off-by: Lukas Burgholzer <lukas.burgholzer@jku.at>
Signed-off-by: Lukas Burgholzer <lukas.burgholzer@jku.at>
Signed-off-by: Lukas Burgholzer <lukas.burgholzer@jku.at>
Signed-off-by: Lukas Burgholzer <lukas.burgholzer@jku.at>
Signed-off-by: Lukas Burgholzer <lukas.burgholzer@jku.at>
@burgholzer burgholzer added feature New feature or request dependencies Pull requests that update a dependency file labels Sep 5, 2022
@burgholzer burgholzer self-assigned this Sep 5, 2022
@codecov
Copy link

codecov bot commented Sep 5, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.1%. Comparing base (a62dd68) to head (b59973c).
Report is 878 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #101   +/-   ##
=====================================
  Coverage   91.1%   91.1%           
=====================================
  Files         20      20           
  Lines       1726    1726           
  Branches     411     411           
=====================================
  Hits        1573    1573           
  Misses       153     153           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@burgholzer burgholzer enabled auto-merge (squash) September 5, 2022 22:23
@burgholzer burgholzer merged commit 41b3b5e into main Sep 5, 2022
@burgholzer burgholzer deleted the pre-commit branch September 5, 2022 23:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant