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

Clarify code standards in the docs #34

Open
Ostrzyciel opened this issue Apr 22, 2024 · 2 comments
Open

Clarify code standards in the docs #34

Ostrzyciel opened this issue Apr 22, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Ostrzyciel
Copy link
Collaborator

In CONTRIBUTING I don't see any mention of code standards or pre-commit checks (which I know are implemented). This should be at least briefly explained there, in particular how to run the pre-commit checks.

@Ostrzyciel Ostrzyciel added the documentation Improvements or additions to documentation label Apr 22, 2024
@Kaszanas
Copy link
Owner

Great catch @Ostrzyciel I will go back and see how much of all of this should be implemented.

Could you verify that the implemented pre-commit checks are sane and should be kept for the version that we are working on?

I will document, and I think that pre-commit checks are also triggered with the CI.

@Ostrzyciel
Copy link
Collaborator Author

Ostrzyciel commented Apr 25, 2024

It's not clear for me what pre-commit checks are there currently :D I didn't dig too deep into this. But, they pass in the CI, so I would consider them "sane".

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

No branches or pull requests

2 participants