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.

Sign up for GitHub

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

Jump to bottom

Create style guide #163

Closed
richardzilincikPantheon opened this issue Oct 13, 2022 · 5 comments
Closed

Create style guide #163

richardzilincikPantheon opened this issue Oct 13, 2022 · 5 comments
Assignees
@bskqd @SlavomirMazurPantheon @richardzilincikPantheon @dmytro-kyrychenko
Labels
enhancement

Comments

@richardzilincikPantheon
Copy link
Contributor

richardzilincikPantheon commented Oct 13, 2022 •
edited
Loading

We need a file with written down rules on code style all developers agree on to keep the whole codebase consistent. It might later be worth looking into enforcing code style with a linter and perhaps running it as part of automated testing.
@richardzilincikPantheon richardzilincikPantheon changed the title Create styling guide Create styly guide Oct 13, 2022
@richardzilincikPantheon richardzilincikPantheon changed the title Create styly guide Create style guide Oct 13, 2022
@bskqd
Copy link
Contributor

bskqd commented Oct 13, 2022

I believe flake8 is a great tool for this, and there's also a pre-commit framework that can be configured with our flake8 configuration, so every commit will be enforced to follow our code style

@richardzilincikPantheon
Copy link
Contributor Author

Style guide created in #164.

@bskqd
Copy link
Contributor

bskqd commented Oct 24, 2022 •
edited
Loading

flake8, black, isort, and pre-commit configurations added to such repositories:
backend: YangCatalog/backend#631 and YangCatalog/backend#635
sdo_analysis: YangCatalog/module-compilation#212
yang-validator-extractor: YangCatalog/yang-validator-extractor#113

A guide for using all these tools locally added to the STYLEGUIDE.md: #166

@richardzilincikPantheon
Copy link
Contributor Author

Great, I think we can close this issue now.

@SlavomirMazurPantheon
Copy link
Contributor

yangre: YangCatalog/yangre#22

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bskqd bskqd

@SlavomirMazurPantheon SlavomirMazurPantheon

@richardzilincikPantheon richardzilincikPantheon

@dmytro-kyrychenko dmytro-kyrychenko

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@bskqd @SlavomirMazurPantheon @richardzilincikPantheon @dmytro-kyrychenko