Back to all reviewers

descriptive specific naming

facebook/react-native
Based on 4 comments
JavaScript

Use descriptive and specific names that clearly communicate purpose and context. Method names should indicate their platform target when applicable, test names should describe the expected behavior, and function names should follow consistent conventions.

Naming Conventions JavaScript

Reviewer Prompt

Use descriptive and specific names that clearly communicate purpose and context. Method names should indicate their platform target when applicable, test names should describe the expected behavior, and function names should follow consistent conventions.

Platform-specific methods: Include the platform in the method name to avoid confusion:

// Instead of
isCatalogAsset(): boolean

// Use
isIOSCatalogAsset(): boolean

Test naming: Test names should be self-explanatory so engineers understand the purpose without reading implementation:

// Instead of
it('Should view properly submit cancel text', async function () {

// Use  
it('Press Cancel Button - Validates cancel confirmation message displays', async function () {

Function naming consistency: Use camelCase for functions and underscore prefix for private methods:

// Instead of
function _download_prebuild_release_tarball(

// Use
function _downloadPrebuildReleaseTarball(

Names should eliminate ambiguity about what code does, which platform it targets, or what behavior it tests. When reviewing code, ask: “Can I understand this element’s purpose from its name alone?”

4
Comments Analyzed
JavaScript
Primary Language
Naming Conventions
Category

Source Discussions