Logo
development/2.0

Contents:

  • Quickstart Guide
  • Installation Guide
  • Operational Guide
  • Developer Guide
    • Architecture Documents
    • How to build MetalK8s
    • How to run components locally
    • Development Best Practices
      • Commit Best Practices
      • Python best practices
  • Glossary
MetalK8s
  • Docs »
  • Developer Guide »
  • Development Best Practices
  • Edit on GitHub

Development Best Practices¶

  • Commit Best Practices
    • How to split a change into commits
      • Why do we need to split changes into commits
      • Examples
        • Cosmetic changes
        • Refactoring
        • Mixing unrelated changes
    • How to write a commit message
      • Why do we need commit messages
      • Anatomy of a good commit message
        • Subject
        • Body
        • Footer
      • Examples
        • Bad commit message
        • Good commit message
          • Commit b531290c04c4
          • Commit 82d92836d4ff
          • Commit f66ac0be1c19
    • Conclusion
  • Python best practices
    • Import
      • Avoid from module_foo import symbol_bar
        • Rationale
        • Example
        • References
    • Naming
      • Predicate functions
        • Rationale
        • Example
    • Patterns and idioms
      • Don’t write code vulnerable to “Time of check to time of use”
        • Rationale
        • Examples
        • References
      • Minimize the amount of code in a try block
        • Rationale
      • Don’t use hasattr in Python 2
        • Rationale
        • Examples
        • References
Next Previous

© Copyright 2019, Scality Revision aef9e895.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: development/2.0
Versions
latest
stable
2.5.1
2.5.0
2.4.3
2.4.2
2.4.1
2.4.0
2.4.0-beta2
2.4.0-beta1
2.4.0-alpha1
2.0.0-alpha3
2.0.0-alpha2
2.0.0-alpha1
1.1.0
1.1.0-alpha1
1.0.1
1.0.0
1.0.0-rc1
0.2.0
0.2.0-rc1
0.1.1
development-2.6
development-2.5
development-2.4
development-2.3
development-2.2
development-2.1
development-2.0
development-1.3
development-1.2
development-1.1
development-1.0
development-0.2
0.1.0
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.