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.

Conduct prop audit as a team

See original GitHub issue

This issue is to conduct a prop audit as a team and determine next steps for prop conventions or renames for the next major release.

Topics to discuss:

  • Conventions for className
  • Conventions for ref
  • Conventions for event handler signatures
  • Convention for open vs isOpen
  • Convention for render* props
  • Convention for aria-label vs label
  • Convention for size variants
    • Do we use a size prop, or is the size itself a prop?

Related issues:

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:1
  • Comments:5 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
joshblackcommented, Aug 19, 2020

@metonym thanks for the input! Love these ideas.

Only one note, for the shortening prop name step I believe we’ll move forward with isFixed instead of fixed. The rationale being that lowercase prop names can be confused with DOM attributes in some cases. There is also confusion as to if states named similarly to something like active correspond to the initial state or the current state. This is something which is* can help to address as a naming convention 👍

We can definitely do this on a case-by-case basis, but might make more sense just to have one convention across the codebase so the API becomes more guess-able instead of being component-specific.

0reactions
joshblackcommented, Oct 29, 2020

Going to close this in favor specific audit lists 👀

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Be a Good Auditor as a Team Leader
Review the audit rules and the process with your team to make sure everyone knows how he should operate. Discuss any concerns, and...
Read more >
5 Expert Steps for You to Get Your Audit Right | Process Street
Assign work to audit team. 18. Initiating the audit: 19. Make arrangements with the auditee. 20. Conduct open meeting.
Read more >
Conducting Human Resource Audits - SHRM
HR usually conducts an audit by using a questionnaire that asks for the evaluation of specific practice areas. This document helps guide the...
Read more >
Real Estate Audit: What Is It and How to Prepare for One
Gather the proper documentation. This typically includes financial statements, transaction documents, property listings, details of trust accounts, property ...
Read more >
Section 3. Auditing and Related Professional Practice Standards
A registered public accounting firm and its associated persons shall comply with all applicable auditing and related professional practice standards.
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