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

Adopt Stylelint's Sass Guidelines on the Frontend library #501

Closed
Golodhros opened this issue Jun 9, 2020 · 1 comment
Closed

Adopt Stylelint's Sass Guidelines on the Frontend library #501

Golodhros opened this issue Jun 9, 2020 · 1 comment
Labels
area:frontend From the Frontend folder good first issue Good for newcomers help wanted Extra attention is needed status:needs_votes Issue or bug fix that needs support from the community to be considered type:maintenance A regular maintenance chore or task, including refactors, build system, CI, performance improvements

Comments

@Golodhros
Copy link
Member

Golodhros commented Jun 9, 2020

We have setup CSS linting with Stylelint and added some basic rules.

To make sure we use styling best practices, reduce our code review effort and provide the best developer experience for our contributors, I suggest to extend the styling rules with the Sass Guidelines. These is an opinionated styleguide for writing sane, maintainable and scalable Sass.

Possible Implementation

In order to do this, we would need to install the dependency following the installation instructions on their repo.

After that, running npm run stylelint will trigger several issues that we would need to solve one by one. The work on this ticket would finish when all the errors and warnings are solved.

Context

Following strict styleguide rules for our code benefits Amundsen as:

  • We spend less time on code reviews
  • We provide a great developer experience to our contributors, increasing the chances of obtaining more help and reducing churn
  • We signal that we are a serious project that care about code quality and good practices
  • We make subsequent changes easier
@Golodhros Golodhros added good first issue Good for newcomers help wanted Extra attention is needed Project: Frontend status:needs_votes Issue or bug fix that needs support from the community to be considered type:maintenance A regular maintenance chore or task, including refactors, build system, CI, performance improvements labels Jun 9, 2020
@stale
Copy link

stale bot commented Jun 23, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the stale label Jun 23, 2020
@feng-tao feng-tao added the keep fresh Disables stalebot from closing an issue label Jul 10, 2020
@stale stale bot removed the stale label Jul 10, 2020
@Golodhros Golodhros added area:frontend From the Frontend folder and removed Project: Frontend labels Dec 15, 2022
@Golodhros Golodhros removed the keep fresh Disables stalebot from closing an issue label Dec 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:frontend From the Frontend folder good first issue Good for newcomers help wanted Extra attention is needed status:needs_votes Issue or bug fix that needs support from the community to be considered type:maintenance A regular maintenance chore or task, including refactors, build system, CI, performance improvements
Projects
None yet
Development

No branches or pull requests

2 participants