Rock Developer Codex
  • Coding Standards
    • Rules
    • Trip Hazards
    • Documenting Code
    • Naming Conventions
      • C#
      • TypeScript
      • Database Naming Conventions
    • Code Styles
    • Style Cop
    • Method Size
    • Commenting Code
    • Method Behavior Parameters ("Options")
      • POCO Location
    • Rock Hotkeys
    • Service Layers
      • Guidelines
      • Data Service Layer
        • EntityTypeConfiguration
      • Client Service Layer
      • Block Layer
      • Client Layer
      • Implementation
    • Namespaces
    • Code Security
    • Patterns in Rock
    • Rock Architecture
      • Locks: C# and/or SQL
      • Event Bus vs TransactionQueue
    • Building Blocks
      • Block Settings
    • RockInternal Attribute
    • JavaScript
    • Defined Types & Defined Values
    • Documentation
    • Known 'Gotchas'
      • Removing Columns From a Grid
    • Bypassing Entity Framework 'Save' Conventions
    • Writing Migrations
      • Standard EF Migrations
        • Feature Branch Merging Workflow
      • Data Migrations
      • Plugin Hotfix Migrations
      • Migration Rollups
      • General Rules
      • Post-Update / Rock Update Helper (For Migrating Data)
      • Normalize Carriage Return Line Feeds
    • Committing Code
      • Release Commits [+]
        • Final Release Notes
      • Grammar & Capitalization in Commit Messages
      • Commit Style Guide
      • Daily Commits [-]
      • Community Member Commits
      • Sparkability Commits
      • Other Commit Notes
      • Working With Issues
    • Code Generator
      • Model Changes
      • Enum Changes
      • System Guid Changes
    • Testing
      • Unit Testing
        • Test Rules
        • Test Names
        • Test Methods
        • Docker Desktop
      • SQL Backup for Testing
    • Hotfix Changes
    • Standard Tools
    • Feature Branches
      • Merging Feature Branches
    • Roles
    • Peer Reviews
      • For the Reviewer
      • For the Receiver
      • Suggestions on How to Peer Review
    • Obsidian Chop, Swap, Sneak
      • Process to Chop or Swap
    • Pre-Alpha Release Process for Developers
      • Verify Release Notes
    • Developer Discussion Decisions
    • SQL Formatting
    • UI Standards
      • Notification Boxes
      • Use of Bootstrap Grid/Row/Column
    • Tips, Tricks, and Recommendations
      • LINQ Debugging
      • Visual Studio Recommended Settings
      • GhostDoc Settings
      • SQL Database Recommended Settings
    • Logging
    • Installation Checklist
    • Maintaining Compatibility
      • Binary Compatibility
      • Tips for Maintaining Compatibility
      • Obsoleting a Type or Method
      • Compatibility FAQ
    • API Patterns
  • App Laws
  • Reference Material
Powered by GitBook
On this page
Export as PDF

Coding Standards

RulesTrip HazardsDocumenting CodeNaming ConventionsCode StylesStyle CopMethod SizeCommenting CodeMethod Behavior Parameters ("Options")Rock HotkeysService LayersNamespacesCode SecurityPatterns in RockRock ArchitectureBuilding BlocksRockInternal AttributeJavaScriptDefined Types & Defined ValuesDocumentationKnown 'Gotchas'Bypassing Entity Framework 'Save' ConventionsWriting MigrationsCommitting CodeCode GeneratorTestingHotfix ChangesStandard ToolsFeature BranchesRolesPeer ReviewsObsidian Chop, Swap, SneakPre-Alpha Release Process for DevelopersDeveloper Discussion DecisionsSQL FormattingUI StandardsTips, Tricks, and RecommendationsLoggingInstallation ChecklistMaintaining CompatibilityAPI Patterns
NextRules