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

Updated README for consistency and readability #128

Merged
merged 1 commit into from
Sep 4, 2012
Merged

Conversation

zzen
Copy link
Contributor

@zzen zzen commented Aug 28, 2012

I've updated the test README a bit since I was struggling with getting started with tests. The formatting on Github was quite broken. I feel the README still needs some work, but I need some guidance, so here are questions for discussion:

  • "Dust core unit-tests" vs "Dust unit-tests using jasmine"
    Are these running the same test suite, only one in node and the other in browser via jasmine? Or do the suites differ in content? (Misleading that one is called "core unit-tests" and the other "unit tests using jasmine"
  • node test/server.js vs node test/jasmine-test/server/specRunner.js vs make test vs make jasmine
    What is the difference between these two styles of calling node.js tests? Does one cover just core and the other full test suite? Are they identical? Why list all four?!
  • can we move cover to Makefile aswell?
    Reason: the recommended node.js practice is NOT to install global packages for project-specific development. Since cover is already listed as a dependency and thus installed via npm install, you can already run it via ./node_modules/.bin/cover - and there's no need installing it again into global namespace. However, the path is a bit cumbersome, so I propose making make cover and make cover-help or just dropping these intructions in favour of existing umbrella make coverage (but fixing the path to be local).
  • finally an almost identical README is duplicated in linkedin/dust-helpers - could the helpers perhaps just point to this README? Keeping them synchronized will be annoying.

@travisbot
Copy link

This pull request passes (merged 1b7d9e6 into 4b3fb75).

@vybs
Copy link
Contributor

vybs commented Aug 28, 2012

Sure sorry for the not so good documentation. We try hard but fall short in this

#1 We will deprecate the "Dust core unit-tests" in version 1.2 and use jasmine only henceforth

#2 Same for node.js

#3 Yes, we should move cover to make file if thats helping

#4 ( very valid )

@jairodemorais can help with this

@jairodemorais
Copy link
Contributor

1- Both runs the same suit, but dust core unit test are inherited code, we are using jasmine for browser and nodejs code.

2- make jasmine runs the jasmine test, make test runs the inherited tests.

3- we could fix the make file to use cover from the node_modules folder.

4- agree.

vybs added a commit that referenced this pull request Sep 4, 2012
Updated README for consistency and readability
@vybs vybs merged commit 8fb65ea into linkedin:master Sep 4, 2012
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

Successfully merging this pull request may close these issues.

4 participants