Skip to content

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

Merged
merged 28 commits into from
Jan 9, 2024
Merged

docs: Add code style guide #518

merged 28 commits into from
Jan 9, 2024

Conversation

Techassi
Copy link
Member

@Techassi Techassi commented Jan 4, 2024

No description provided.

@Techassi Techassi self-assigned this Jan 4, 2024
Copy link

netlify bot commented Jan 4, 2024

Deploy Preview for stackable-docs failed.

Name Link
🔨 Latest commit fae529a
🔍 Latest deploy log https://app.netlify.com/sites/stackable-docs/deploys/659d4329f358930008e7d348

@Techassi Techassi marked this pull request as ready for review January 4, 2024 12:17
@Techassi Techassi requested a review from a team January 5, 2024 08:24
Copy link
Member

@NickLarsenNZ NickLarsenNZ left a 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

@nightkr
Copy link
Member

nightkr commented Jan 5, 2024

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!

@NickLarsenNZ
Copy link
Member

NickLarsenNZ commented Jan 5, 2024

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?

Copy link
Member

@sbernauer sbernauer left a 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

@NickLarsenNZ NickLarsenNZ self-requested a review January 9, 2024 09:23
Copy link
Member

@NickLarsenNZ NickLarsenNZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Techassi Techassi added this pull request to the merge queue Jan 9, 2024
Merged via the queue into main with commit 21a423a Jan 9, 2024
@Techassi Techassi deleted the doc/add-code-style-rules branch January 9, 2024 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants