4.11. useblocks convention of Python development
- We keep all stuff, which belongs together, inside one repository
- We can open all stuff, which is developed by us, in our IDE
- We write and use tests
- We write and publish user documentation
- We publish code, tests, documentation as versioned package
- We use logging libraries inside our tools
- We provide configuration capabilities for our tools
- We use exceptions
- We have and follow coding rules
- We write tons of documentation inside our code
- We are using continuous integration with ruthless tests
4.11.1. We keep all stuff, which belongs together, inside one repository
- Everything can get an issue in our bug tracker
- Everything can get a version
- Everything is in sync
4.11.2. We can open all stuff, which is developed by us, in our IDE
- No annoying tool switches
- No additional Know How needed
- No “I do it later, when I have finished here…”
- Creating links between code, tests and documentation is easy
4.11.3. We write and use tests
- We can sleep well during nights
- Tests are written once and reused hundreds of time
- You can trust others to make changes to your code
- You find bugs during writing of tests
- You use your code the same way like other developers will do
4.11.4. We write and publish user documentation
- A link via eMail or 2 hours telephone support. You have the choice
- Use it for selling your tool
4.11.5. We publish code, tests, documentation as versioned package
- Proof the quality of your work to the user
- Let the user get everything, which may be needed, with one download
- Know if something is outdated
4.11.8. We use exceptions
- Do not only use print or log messages for errors
- Let calling function know about errors
- Let calling functions decide how to treat errors
4.11.9. We have and follow coding rules
- Other developers can easily read your code
- Other developers can extend your code
- Reduces the source of errors
4.11.10. We write tons of documentation inside our code
- Other developers can easily understand and extend your code
- Documentation can be reused outside the code (documentation, application)
- Documentation can be used to automatically generate test cases.
4.11.11. We are using continuous integration with ruthless tests
- Be sure that each commit fulfills the above rules
- Get great quality with each commit
- Do not get buggy code from others