... | ... | @@ -8,10 +8,21 @@ |
|
|
# Environment
|
|
|
|
|
|
|
|
|
#### C1: Inappropriate Information
|
|
|
#### E1: Build Requires More Than One Step
|
|
|
|
|
|
It is inappropriate for a comment to hold information better held in a different kind of system such as your source code control system, your issue tracking system, or any other record-keeping system. Change histories, for example, just clutter up source files with volumes of historical and uninteresting text. In general, meta-data such as authors, last- modified-date, SPR number, and so on should not appear in comments. Comments should be reserved for technical notes about the code and design.
|
|
|
Building a project should be a single trivial operation. You should not have to check many little pieces out from source code control. You should not need a sequence of arcane com- mands or context dependent scripts in order to build the individual elements. You should not have to search near and far for all the various little extra JARs, XML files, and other artifacts that the system requires. You should be able to check out the system with one simple command and then issue one other simple command to build it.
|
|
|
|
|
|
```bash
|
|
|
|
|
|
svn get mySystem
|
|
|
cd mySystem
|
|
|
ant all
|
|
|
|
|
|
```
|
|
|
|
|
|
#### E2: Tests Require More Than One Step
|
|
|
|
|
|
You should be able to run all the unit tests with just one command. In the best case you can run all the tests by clicking on one button in your IDE. In the worst case you should be able to issue a single simple command in a shell. Being able to run all the tests is so fundamental and so important that it should be quick, easy, and obvious to do.
|
|
|
|
|
|
|
|
|
|
... | ... | |