Welcome¶
Important
This documentation is intended for the lucky people developing TAU Commander. If you are a TAU Commander user then you should visit the TAU Commander website. If you’re looking for information on the TAU Performance System (the heart of TAU Commander) then you should visit the TAU project page.
This document will help you, the TAU Commander developer, contribute to the project. For over two decades the TAU Performance System has been developed primarily by graduate students with extreme demands on their time so best practices of software design, safety, and maintainability were largely ignored in favor of getting results quickly. This short term thinking ran up an enormous technical debt in TAU and created a “wet spaghetti” code base where TAU developers throw stuff at the wall to see what sticks. The goal of this developer’s guide to bring a little sanity back to the development cycle and take advantage of important software engineering lessons learned in the last two decades.
Remember: Code with a pylint score less than 9 will not be accepted to the master branch.
The TAU Commandments¶
- Thou shalt use pylint 1.6.4 or later as part of your development cycle.
- Thou shalt follow the TAU Commander Design for it is sacred.
- Thou shalt style thine code according to the TAU Commander Code Style.
- Thou shalt document your code according to the TAU Commander Code Documentation.
- Never shalt thou develop on the master branch, for that is an abomination.
- Never shalt thou merge code into the master branch that is failing the continuous integration (CI) tests.
- Never shalt thou just quickly fix this one thing because I have a hard deadline I forgot and now I really really really need this feature to be part of TAU Commander whatever the cost and oh God I broke it I broke it and everything is on fire.