question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Docs: More Style Guide entries

See original GitHub issue

What docs page is being added or updated?

  • Section: Style Guide
  • Page: Style Guide

For Updating Existing Content

What updates should be made to the page?

Some additional items I’d like to add:

  • Organize reducers based on type of data and features, not specific components
  • Use hooks as the default, instead of connect
  • Name state slices after their data, without the word reducer in the name (ie, state.users, not state.usersReducer)

Any others we should add?

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:8 (5 by maintainers)

github_iconTop GitHub Comments

3reactions
Luchansocommented, Aug 25, 2020

Recommendation like 'no-param-reassign': ['error', { props: true, ignorePropertyModificationsFor: ['state'] }], this will ignore rule for state variable

0reactions
markeriksoncommented, Mar 21, 2021

Going to mark this as resolved. I don’t think we specifically should add the no-param-reassign thing in the style guide, but I’ll mention it in the RTK “Writing Reducers with Immer” usage guide.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Style Guides - Write the Docs
A style guide saves documentarians time and trouble by providing a single reference for writing about common topics, features, and more.
Read more >
What's new | Google developer documentation style guide
Expanded and clarified guidance about placeholders. Formatting placeholders. New entries: outside the box (and related terms), and more than 40 networking terms ...
Read more >
StyleGuide.doc - Google Docs
(See more comma uses in series in AP Stylebook.) ... blog A website where short entries are usually (but not always) printed in....
Read more >
Writing style guide - The MDN Web Docs project
This writing style guide describes how content should be written, organized, spelled, and formatted on MDN Web Docs.
Read more >
How to Create a Style Guide: 5 Components of a Style Guide
Also known as a writing style guide, this manual establishes the standard requirements for grammar, punctuation, tense, tone, wording, and ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found