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

Improve overall depth and presentation #28

Open
ehenoma opened this issue Aug 2, 2022 · 0 comments
Open

Improve overall depth and presentation #28

ehenoma opened this issue Aug 2, 2022 · 0 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone

Comments

@ehenoma
Copy link
Member

ehenoma commented Aug 2, 2022

We should improve the style guide by:

Generally updating rules

New rules have come up and existing rules may have slightly changed over the past two years.
We should address that in an updated guide.

Making it more structured

Using a website instead of document can make the style guide more discoverable and navigable.
It also allows us to go more in-depth about specific rules and provide some interactive features
like comments.

Adding more topics

There are many topics left out right now. We should cover all the subjects that would come up
in a general code review.

@ehenoma ehenoma added enhancement New feature or request help wanted Extra attention is needed labels Aug 2, 2022
@felixklauke felixklauke added this to the 2022 Overhaul milestone Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Development

No branches or pull requests

2 participants