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

Write docs #39

Open
5 of 9 tasks
per-gron opened this issue Dec 7, 2014 · 0 comments
Open
5 of 9 tasks

Write docs #39

per-gron opened this issue Dec 7, 2014 · 0 comments

Comments

@per-gron
Copy link
Owner

per-gron commented Dec 7, 2014

Top level

  • What it is. [… if this sounds just like Mocha to you, it's because it is very similar to Mocha.] For node only.
  • Features
  • Usage
    • Installation
    • Write a test (including how to do assertions and where to place the file)
    • Run the test
  • Contributing
    • Make sure tests and the linter passes
    • If applicable update documentation

Sub-pages

  • Writing tests using the BDD interface: Document the BDD interface #43
  • Running tests with the CLI
  • Running tests with the Javascript API Document the suite runner API #56
  • How to interpret error messages
  • Tools for improving error reporting
  • Writing custom reporters using the Reporter API: Document the reporter API #44
  • Writing custom interfaces with the Interface API: Document the interface API #46
  • Differences compared to Mocha
    • Tests run in separate process (consequences for speed, before/after hooks, communication between tests and reporters)
    • After hooks are not executed on timeout
    • node only
    • Mention that there are probably unnecessary differences, they should be fixed
  • Internal architecture
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant