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

Script example should be standalone #41

Open
wconrad opened this issue Oct 28, 2017 · 0 comments
Open

Script example should be standalone #41

wconrad opened this issue Oct 28, 2017 · 0 comments

Comments

@wconrad
Copy link

wconrad commented Oct 28, 2017

The script example should be standalone, able to run without any gems that need configuration and without needing a connection to a database (or anything else). This would:

  • Let someone run the example to see how tunemygc works, before they even instrument their application.
  • Make the example usable as a debugging aid ("I can't get my app to work with tunemygc. Let's at least see the standalone example work to rule out any problems with infrastructure, etc.")

It is the use of the queue_classic gem that causes trouble here. Ideally, the example should use no gems other than tunemygc, but any gems the example does use should need no configuration or connections to anything.

It would also be useful if the script included a comment or shebang with the Ruby version that you tested it with. This would help to eliminate a question in my mind when I'm trying to get things to work ("Is my problem because of the version of Ruby I'm using? Let's run the example with the exact same Ruby mentioned in the shebang and find out.")

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