2. Programming Best Practices

These pages describe programming related best practices in the context of developing the Chevah project.

They are not generic and might not apply to ohter projects which have other requirements.

• 2.1. Generic Programing Advice
  • 2.1.1. General
  • 2.1.2. Exceptions handling
  • 2.1.3. Logging
  • 2.1.4. Configuration
• 2.2. Review
  • 2.2.1. General
  • 2.2.2. For the person requesting a review
  • 2.2.3. For the person reviewing the changes
• 2.3. Testing
  • 2.3.1. Test Data
  • 2.3.2. Types of tests
  • 2.3.3. Developing using tests
  • 2.3.4. Structure of a test
  • 2.3.5. Smells
  • 2.3.6. Naming conventions
  • 2.3.7. Test fixtures, addCleanup, setUp and tearDown
  • 2.3.8. Tests description - docstrings
  • 2.3.9. Dealing with flaky tests
  • 2.3.10. Rerefences
• 2.4. Documenting the code
  • 2.4.1. Test code docstrings
  • 2.4.2. Production code docstrings
• 2.5. Bugs and Tech-Debt
  • 2.5.1. General
  • 2.5.2. Defects and Release Blockers
  • 2.5.3. Reporting a bug
  • 2.5.4. Technical Debt
  • 2.5.5. Shared code and refactoring for code reusal
  • 2.5.6. FIXME Markers
  • 2.5.7. Happy Hacking Day
  • 2.5.8. References
• 2.6. Dependencies
  • 2.6.1. PyPI Mirror/Custom Index
  • 2.6.2. Python
  • 2.6.3. Javascript