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

Update code styling rules #779

Open
ignas-k opened this issue Mar 20, 2024 · 1 comment
Open

Update code styling rules #779

ignas-k opened this issue Mar 20, 2024 · 1 comment
Labels
good first issue Good for newcomers internal No change in this PR have impact on the public package features.

Comments

@ignas-k
Copy link
Contributor

ignas-k commented Mar 20, 2024

Is your feature request related to a problem? Please describe.

Currently the code styling rules are loose and subjective. It would be better to clearly define them all and enforce them properly. With strictly defined styling rules it would be easier for developers to write code correctly and the code would become more consistent across the whole repository. Additionally, it would be beneficial to review our current ESLint and Prettier rules e.g. import order, line gaps etc.

Describe the Solution you'd like

A few major tasks:

  • Update STYLEGUIDE.md (and CONTRIBUTING.md if needed).
  • Review ESLint and Prettier rules.
  • Refactor existing code with the new rules.

TBA: smaller tasks for each category about specific styling rules

Describe alternatives you've considered

No response

Additional context

No response

@ignas-k ignas-k added the internal No change in this PR have impact on the public package features. label Mar 20, 2024
@ignas-k ignas-k self-assigned this Mar 20, 2024
@GerardasB GerardasB added the good first issue Good for newcomers label Aug 8, 2024
@GerardasB
Copy link
Collaborator

Please update package.json fields and README.md as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers internal No change in this PR have impact on the public package features.
Projects
None yet
Development

No branches or pull requests

2 participants