This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
package org.testfu.storm; | |
import backtype.storm.Config; | |
import backtype.storm.LocalCluster; | |
import backtype.storm.LocalDRPC; | |
import backtype.storm.StormSubmitter; | |
import backtype.storm.generated.StormTopology; | |
import backtype.storm.tuple.Fields; | |
import storm.trident.TridentState; | |
import storm.trident.TridentTopology; |
The philosophy behind Documentation-Driven Development is a simple: from the perspective of a user, if a feature is not documented, then it doesn't exist, and if a feature is documented incorrectly, then it's broken.
- Document the feature first. Figure out how you're going to describe the feature to users; if it's not documented, it doesn't exist. Documentation is the best way to define a feature in a user's eyes.
- Whenever possible, documentation should be reviewed by users (community or Spark Elite) before any development begins.
- Once documentation has been written, development should commence, and test-driven development is preferred.
- Unit tests should be written that test the features as described by the documentation. If the functionality ever comes out of alignment with the documentation, tests should fail.
- When a feature is being modified, it should be modified documentation-first.
- When documentation is modified, so should be the tests.
The README.md
file and supporting documents should describe the following, in this order. If the file starts getting long, break it into pieces
- Project Titles as a level-1 heading
- with descriptive tagline: I should be informed and intrigued. Examples:
- "Sinatra is a DSL for quickly creating web applications in Ruby with minimal effort"
- with descriptive tagline: I should be informed and intrigued. Examples: