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

Considering using Prettier and research on setup via CL and Plugin #4059

Open
4 tasks
MicahBear opened this issue Mar 1, 2023 · 2 comments · May be fixed by #5023
Open
4 tasks

Considering using Prettier and research on setup via CL and Plugin #4059

MicahBear opened this issue Mar 1, 2023 · 2 comments · May be fixed by #5023
Assignees
@nssensalo
Labels
Complexity: Medium Discussion Starting point for gathering further information and/or feedback Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly role: dev leads Tasks for technical leads and/or merge team members size: 1pt Can be done in 4-6 hours
Projects
Project Board
Milestone
08. Team workflow

Comments

@MicahBear
Copy link
Member

MicahBear commented Mar 1, 2023 •
edited
Loading

Overview

We need to consider implementing a solution like Prettier to prevent developers from pushing additional file changes due to formatting preferences in their IDE. This helps to reduce 50+ line changes when a simple alt text is changed due to a developer’s auto-format save.

Details

The discussion from Thursday (02-23-23) Office hours, considering the use of Prettier (opinionated code formatter) on website repo because many devs use it and have to remember to disable Prettier or it is forgotten, especially by just onboarded devs. The consensus was there is a need to research what that looks like and if it would be beneficial/easy.

Action Items

  • Invite other devs to comment on issue
    • questions to ask:
      • Do you use it?
      • Do you like it?
      • If you don't use it, why don't you?
  • Research the process use and install Prettier locally -per project.
  • Research the process of using Prettier via editor.
  • Present and discuss with Website team.

Reservations & Concerns

  • What if people don't want to install prettier?
  • How does this impact PR reviews
  • What would we need to do to existing code in the repo

Resources/Instructions
@MicahBear MicahBear added Complexity: Small Take this type of issues after the successful merge of your second good first issue ready for dev lead Issues that tech leads or merge team members need to follow up on labels Mar 1, 2023
@MicahBear MicahBear added this to New Issue Approval in Project Board via automation Mar 1, 2023
@github-actions github-actions bot added Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing labels Mar 1, 2023
@MicahBear MicahBear added role: back end/devOps Tasks for back-end developers Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly and removed role missing Feature Missing This label means that the issue needs to be linked to a precise feature label. labels Mar 1, 2023
@jdingeman jdingeman added the size: 1pt Can be done in 4-6 hours label Mar 3, 2023
@jdingeman jdingeman changed the title Considering using Prettier, need research on setup via CL and Plugin Considering using Prettier and research on setup via CL and Plugin Mar 3, 2023
@jdingeman jdingeman added Ready for Prioritization and removed ready for dev lead Issues that tech leads or merge team members need to follow up on labels Mar 3, 2023
@ExperimentsInHonesty ExperimentsInHonesty added Discussion Starting point for gathering further information and/or feedback Complexity: Medium and removed Complexity: Small Take this type of issues after the successful merge of your second good first issue labels Mar 5, 2023
@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Mar 5, 2023 •
edited
Loading

@MicahBear we think this issue will need to be more thought out. Thanks for making the issue. Things to include in the planning are

  • What would we need to do to existing code in the repo
  • How does this impact PR reviews
  • What if people don't want to install prettier ?
  • etc.

Please also invite devs to leave comments on this issue
Do you use it?
Do you like it?
Why don't you use it? Reservations & Concerns

@ExperimentsInHonesty ExperimentsInHonesty added this to the 08. Team workflow milestone Mar 5, 2023
@ExperimentsInHonesty ExperimentsInHonesty added role: front end Tasks for front end developers role: dev leads Tasks for technical leads and/or merge team members labels Mar 5, 2023
@ExperimentsInHonesty ExperimentsInHonesty moved this from New Issue Approval to Prioritized backlog in Project Board Mar 5, 2023
@ExperimentsInHonesty ExperimentsInHonesty removed role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers labels Mar 21, 2023
@ronaldpaek
Copy link
Member

@ExperimentsInHonesty I am not an expert on prettier and formatting, but I had some formatting issues. I thought it was my computer, but it's cause the site doesn't have any linter or config files to make the spacing and syntax uniform. Those issues arise from some people having trailing white space on save, where it removes white space, and others leaving it on. I thought we use docker as our container, so we don't have to worry about things being different on other's computers, but usually, when I use prettier, I have it installed. It formats on save, but if we were to apply prettier for the site, it would be a GitHub action where it would check/format the code before it lets you make a PR.

I don't know how to do all this 100%, but it's possible, and from what I can tell, we already have an SCSS Linter. All this can be done incrementally, meaning. Per file type of thing, that could potentially be a lot of small issues; of course, there is the format of every file, but I don't think that's feasible, and that is what you don't sure. 😄

@ronaldpaek ronaldpaek linked a pull request Jul 19, 2023 that will close this issue
Draft
@nssensalo nssensalo self-assigned this Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nssensalo nssensalo

Labels
Complexity: Medium Discussion Starting point for gathering further information and/or feedback Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly role: dev leads Tasks for technical leads and/or merge team members size: 1pt Can be done in 4-6 hours
Projects
HfLA Website: Project Board
Status: Prioritized backlog
Project Board
  
Prioritized backlog
Milestone
08. Team workflow
Development

Successfully merging a pull request may close this issue.

DO NOT REVIEW: Prettier and research on setup via CL and Plugin ronaldpaek/website
5 participants
@ExperimentsInHonesty @MicahBear @nssensalo @jdingeman @ronaldpaek