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

Improve readme and --help #473

Merged
merged 13 commits into from
Jan 20, 2021
Merged

Conversation

lydell
Copy link
Collaborator

@lydell lydell commented Nov 15, 2020

  • Recommend installing locally. Fixes Recommend local rather than global install #249.
  • Move more common flags first, both in the readme and in --help.
  • Sync the descriptions between the readme and --help.
  • Try to explain the difference between node-test-runner and elm-explorations/test.
  • Document where to put your tests.
  • Various other little tweaks to try to be more helpful.

PR for elm-explorations/test: elm-explorations/test#160

We should also update the repo description because it currently says:

Runs elm-test suites from Node.js. Get it with npm install -g elm-test

@harrysarson harrysarson added the status: waiting for review Pull request needs a review label Nov 15, 2020
@harrysarson
Copy link
Collaborator

harrysarson commented Nov 20, 2020

Hi yes, I am not sure how to review this. I dunno how people do code review on prose.

Stylistically I have a preference for avoiding the passive voice. (So "it is recommended" would become "we recommend".)

@lydell
Copy link
Collaborator Author

lydell commented Nov 20, 2020

If you like it overall, feel free to make whatever tweaks you like and push them to my branch if you want.

For broader changes, feel free to suggest things like “remove this section”, “this is good but that is more important so it should be more prominent” or “I see what problems you tried to solve but I’d like to phrase things a completely different way”. Or push big changes to my branch if you feel like it. Or another branch based on mine.

Or review any way you like. I don’t mind. 😄

Edit: Also, if “please avoid passive voice” is your only piece of feedback I can try to fix it myself too.

@harrysarson harrysarson self-assigned this Jan 2, 2021
Copy link
Collaborator

@harrysarson harrysarson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put some comments. A lot are very minor and almost all are subjective so feel free to push back.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@harrysarson
Copy link
Collaborator

I am happy, will just wait and see if anyone else wants to take a look before we merge.

@lydell lydell mentioned this pull request Jan 15, 2021
Conflicts:
	lib/elm-test.js
@harrysarson harrysarson merged commit 995b916 into rtfeldman:master Jan 20, 2021
@lydell lydell deleted the improve-readme branch January 20, 2021 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting for review Pull request needs a review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Recommend local rather than global install
2 participants