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

Add formatter #84

Open
mark-wiemer opened this issue Dec 21, 2024 · 7 comments
Open

Add formatter #84

mark-wiemer opened this issue Dec 21, 2024 · 7 comments
Labels
CI Build process Meta Related to project structure or procedures

Comments

@mark-wiemer
Copy link
Contributor

Greatly reduces decision fatigue while writing documents :)

  • CI fails if any file is not formatted
  • Single well-documented command can be used by contributors to format the entire repo
  • Files can easily be ignored or unignored
@wsor4035
Copy link
Collaborator

ci shouldnt be added till #15 is done

@mark-wiemer
Copy link
Contributor Author

Fair enough

@GreenXenith GreenXenith added Meta Related to project structure or procedures CI Build process labels Dec 21, 2024
@appgurueu
Copy link
Contributor

Side note, it's also possible to have actions that directly commit to the working branches of PRs. I feel this could be neat to make the process smoother.

@mark-wiemer
Copy link
Contributor Author

Yes, as long as the auto-committed code is thoroughly reviewed! Of course, that should apply to human-written code, but I think we've all had our oopsies with that. But yeah, I'm in favor of experimenting with this

@appgurueu
Copy link
Contributor

A correct formatter should not require review of its output, it should only make changes that don't change anything semantically (like converting - to * in Markdown lists for example).

@mark-wiemer
Copy link
Contributor Author

In my book, any changes to any files require review--you just never know!! But yes, formatters like Prettier should be fine, but we should always review as we're responsible for ensuring the stuff we merge and deploy is good, we can never "blame the formatter"

@grorp
Copy link
Member

grorp commented Dec 22, 2024

Prettier is nice

ci shouldnt be added till #15 is done

Why not? Wouldn't having automatic formatting make importing pages easier, since you'd have one thing less to worry about?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Build process Meta Related to project structure or procedures
Projects
None yet
Development

No branches or pull requests

5 participants