123.0.4
Contents:
Installation
Operation
Developer Guide
Architecture Documents
How to build MetalK8s
How to run components locally
Deploy new MetalK8s image
Development
Developing Tests
Development Best Practices
Commit Best Practices
Python best practices
Integrating with MetalK8s
Shared Tooling
Glossary
MetalK8s
»
Developer Guide
»
Development
»
Development Best Practices
Edit on GitHub
Development Best Practices
¶
Commit Best Practices
Pre-commit hooks
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
Read the Docs
v: 123.0.4
Versions
latest
stable
123.0.4
123.0.3
123.0.2
123.0.1
123.0.0
123.0.0-alpha.3
123.0.0-alpha.2
123.0.0-alpha.1
2.11.8
2.11.7
2.11.6
2.11.5
2.11.4
2.11.3
2.11.2
2.11.1
2.11.0
2.11.0-alpha2
2.11.0-alpha1
2.10.8
2.10.7
2.10.6
2.10.5
2.10.4
2.10.3
2.10.2
2.10.1
2.10.0
2.10.0-beta3
2.10.0-beta2
2.10.0-beta1
2.10.0-alpha1
2.9.2
2.9.1
2.9.0
2.9.0-alpha2
2.9.0-alpha1
2.8.0
2.7.3
2.7.2
2.7.1
2.7.0
2.6.1
2.6.0
2.5.2
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.9
development-2.8
development-2.7
development-2.6
development-2.5
development-2.4
development-2.3
development-2.2
development-2.11
development-2.10
development-2.1
development-2.0
development-1.3
development-123.0
development-1.2
development-1.1
development-1.0
development-0.2
0.1.0
Downloads
On Read the Docs
Project Home
Builds