Open
Description
Currently the guides on writing specs are really quite basic. One of the most common problems I currently face is dealing with pull-requests that add specs that don't go for the full 100%. In almost all cases this problem can be broken into two categories:
- Spec descriptions are too short (e.g.
it "returns X" vs
it "returns X when given an instance of Y"`). - Example blocks are far too big instead of only containing the bare minimum needed to test certain behaviour.
The old RubySpec website had a pretty decent guide on writing specs and I think we should re-use that in some shape or form. What it should at least cover:
- Where certain specs go (this isn't always clear when just searching for similar code)
- How to write good spec descriptions
- Some techniques on cutting down the size of example blocks (and why)
- How to tag specs/remove tags
- How to deal with complex setup code
- The importance of all of the above
Metadata
Metadata
Assignees
Labels
No labels