-
-
Notifications
You must be signed in to change notification settings - Fork 12
docs: Add code style guide #518
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
Conversation
❌ Deploy Preview for stackable-docs failed.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really nice, thanks for this! I was just recently looking for the rule about variants which I knew I'd seen somewhere (but was hidden in a private document).
I think adding reasons for each rule would be good,
- it helps the reader understand why the rule exists
- over time, reasons can become invalid and we can replace/remove the rule instead of it becoming dogma
Also, this conventional commits obsession is getting insane. This is the docs repository. It contains nothing but docs. Of course every single PR is going to be about docs! |
@nightkr there's also ci (rareley changes), but yeah, the limited variance of types of changes makes conventional commits a bit too much in this repo. But also, it becomes habit too, so can we allow them but not enforce them here? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot, LGTM % comments
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
No description provided.