Skip to content

Conversation

@tim-sh
Copy link
Member

@tim-sh tim-sh commented Oct 16, 2025

These are somewhat opinionated, discussable rules that I nevertheless thought useful to improve quality.

@tim-sh tim-sh requested a review from daogrady October 16, 2025 13:32
@tim-sh
Copy link
Member Author

tim-sh commented Oct 16, 2025

OK, that should be it for this PR :)

@tim-sh tim-sh force-pushed the docs/bestPractices branch from 204980c to d19f76d Compare October 16, 2025 19:12
@daogrady
Copy link
Contributor

daogrady commented Oct 22, 2025

Can we have as many of them as possible expressed through lint rules?
While some, like "meaningful names", are likely impossible to detect automatically (AI?), for at least some there should be appropriate rules. For example, there appear to be plugins concerned with restricting mutability.
I am a strong proponent of clean code and consistent style, so I am strongly in favour of establishing a style guide. But as these best practices are not org-wide, I'd probably stumble over them again and again when having to switch context and making sure I adhere to them. So having The Machine(tm) slap my wrist would be nice.

@tim-sh
Copy link
Member Author

tim-sh commented Oct 22, 2025

I’m with you and I think that’s a good next issue. The present PR is concerned with documenting it first.

@tim-sh tim-sh enabled auto-merge (squash) October 22, 2025 14:41
@tim-sh tim-sh merged commit b6762d5 into main Oct 22, 2025
10 of 13 checks passed
@tim-sh tim-sh deleted the docs/bestPractices branch October 22, 2025 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants