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

Update mylib.xml #1

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update mylib.xml #1

wants to merge 1 commit into from

Conversation

mnwk
Copy link
Owner

@mnwk mnwk commented Nov 13, 2023

PR Review Checklist

Start with Tests

FIRST

  • Fast
  • Independent/Isolated
  • Repeatable
  • Self-Validating
  • Timely

Additional Clean Code Principles

  • Clarity and Simplicity in tests
  • Descriptive Names for test cases
  • Minimal Unit of Test - Focus on a small aspect of functionality
  • Arrange-Act-Assert Pattern
  • Refactoring and Maintenance of tests
  • Error Handling and Edge Cases in tests
  • Appropriate use of Mocking and Stubbing

Review the Actual Change

  • Readability of code
  • Simplicity and Design - Simplest solution possible
  • Naming Conventions - Appropriately and consistently named
  • Function Length and Responsibilities
  • Comments and Documentation - Necessary and explanatory

Architecture and Design Patterns

  • Consistency with Existing Code
  • Appropriate use of Design Patterns

Technical Debt

  • Identification and assessment of Technical Debt

Robust Error Handling

  • Exceptions Over Return Codes
  • Separation of Concerns in error handling
  • Meaningful Exceptions according to caller's needs

Adequate Logging

  • Meaningful Log Messages
  • Appropriate Log Levels
  • Privacy considerations in logging
  • Comprehensive Error Logging

Documentation and Readme Updates

  • Documentation Consistency with code changes
  • Clear Instructions for setup, configuration, or deployment changes

Integration and Compatibility (if applicable)

  • Backward Compatibility

Performance and Efficiency (if applicable)

  • Optimization and code performance

Security and Best Practices (if applicable)

  • Security Practices
  • Adherence to Best Practices and Standards

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant