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

(MAINT) improve README description #3

Merged
merged 1 commit into from
Jun 15, 2017

Conversation

kevpl
Copy link
Contributor

@kevpl kevpl commented Jun 7, 2017

[skip ci]

README.md Outdated
next to beaker itself.

Once you've done that & installed the games, in your test, you'll have to
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we opinionated about if we want people to do this in their test files or in their helper somewhere? This might be a good place to endorse the usage of helpers to make the DSL available to the entirety of a test run, instead of individual tests.

Also, I think that you mean "installed the gems" not "installed the games". 👾 🎲 🎮

README.md Outdated
### Right Now?

At this point, beaker-puppet is included in beaker, so you don't have to _do_
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we should specify the version 3.x here?

@kevpl
Copy link
Contributor Author

kevpl commented Jun 15, 2017

@tvpartytonight to your question about versions: great point, I've put version numbers in the section headers. Look good ❓

Fixed the typo (games -> gems), and to the larger question left there (from outdated folder):

Are we opinionated about if we want people to do this in their test
files or in their helper somewhere? This might be a good place to
endorse the usage of helpers to make the DSL available to the
entirety of a test run, instead of individual tests.

My opinion is that people should use the library code exactly where they need it. It will typically be from a test, but if they want to write their own helpers on top of the methods in the library, then they'll have to include it there too. I don't see the advantage of being opinionated about which place this goes in at this point. Am I just missing the advantage you're thinking of ❓

@tvpartytonight
Copy link
Contributor

Once a library is required in more than just a few files/tests, I think it makes sense to include at the helper level, since it reduces copy 🍝 from test to test. But the language here is fine, I just wanted to bring it up since I was thinking about it.

@tvpartytonight tvpartytonight merged commit d5fe9d1 into puppetlabs:master Jun 15, 2017
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.

2 participants