Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand guides on writing specs #45

Open
yorickpeterse opened this issue Jan 5, 2015 · 0 comments
Open

Expand guides on writing specs #45

yorickpeterse opened this issue Jan 5, 2015 · 0 comments

Comments

@yorickpeterse
Copy link
Contributor

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:

  1. Spec descriptions are too short (e.g. it "returns X" vsit "returns X when given an instance of Y"`).
  2. 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:

  1. Where certain specs go (this isn't always clear when just searching for similar code)
  2. How to write good spec descriptions
  3. Some techniques on cutting down the size of example blocks (and why)
  4. How to tag specs/remove tags
  5. How to deal with complex setup code
  6. The importance of all of the above
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant