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 formatting and linting #5

Merged
merged 5 commits into from
Feb 14, 2025
Merged

Add formatting and linting #5

merged 5 commits into from
Feb 14, 2025

Conversation

mkannwischer
Copy link
Contributor

@mkannwischer mkannwischer commented Feb 12, 2025

This PR copies the format script from mlkem-native: clang-format for C code, nixpkgs-fmt for nix files, shfmt for shell scripts, black for Python scripts.

It also adds a lint script that is run in CI. This checks that all files are correctly formatted and additionally checks that copyright and license headers are present in all files.

In the process, I reformatted all the sources and added the missing license and copyright headers.

Stapled onto this PR: Adding CODEOWNERS and MAINTAINERS.md.

Signed-off-by: Matthias J. Kannwischer <matthias@kannwischer.eu>
Signed-off-by: Matthias J. Kannwischer <matthias@kannwischer.eu>
Signed-off-by: Matthias J. Kannwischer <matthias@kannwischer.eu>
Signed-off-by: Matthias J. Kannwischer <matthias@kannwischer.eu>
Signed-off-by: Matthias J. Kannwischer <matthias@kannwischer.eu>
@mkannwischer mkannwischer requested a review from a team February 12, 2025 03:08
@mkannwischer mkannwischer marked this pull request as ready for review February 12, 2025 03:08
@jakemas
Copy link
Contributor

jakemas commented Feb 12, 2025

Great! Taking a look!

Copy link
Contributor

@jakemas jakemas left a comment

Choose a reason for hiding this comment

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

Thank you! LGTM

@jakemas jakemas merged commit 62ba82d into main Feb 14, 2025
9 checks passed
@jakemas jakemas deleted the format branch February 14, 2025 00:44
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.

2 participants