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

Make this this best possible example for html-proofer #2

Closed
7 tasks done
fulldecent opened this issue May 2, 2017 · 5 comments
Closed
7 tasks done

Make this this best possible example for html-proofer #2

fulldecent opened this issue May 2, 2017 · 5 comments
Assignees

Comments

@fulldecent
Copy link
Owner

fulldecent commented May 2, 2017

@gjtorikian please assist with item 1 here.

Before pushing to RubyGems, I would like to ensure this simple project meets the highest quality standards. Because then we will create more custom tests and I hope to publish this one on a new wiki at the html-proofer project.

  • Decide on the correct gem name
    • Confirm this repository is named using best practices -- how can I confirm it is?
  • Implement tests using spec
    • Add Travis CI testing
  • Follow bundle gem project format (minus bin/ directory)
    • Discussion: is this best practice?
  • Publish to rubygems (@fulldecent to do this)
  • Publish to html-proofer wiki with discussion
@gjtorikian
Copy link

Which item should I assist with?

@fulldecent
Copy link
Owner Author

@gjtorikian Could you please advise what the preferred "Ruby name" is I should use for this project?

What we currently have is html-proofer-mailto-awesome in https://github.com/fulldecent/html-proofer-mailto-awesome/blob/master/html-proofer-mailto-awesome.gemspec

Should there be underscores in there instead? Perhaps html-proofer-mailto_awesome or html_proofer-mailto_awesome?

Also, if you have any other advice on this work plan, please let me know. I intend to publish this on a html-proofer wiki, so hopefully everyone will follow the lead here.

@fulldecent
Copy link
Owner Author

@ilyalyo Please help with adding spec testing and adding a travis CI file. And also a Travis build badge on the README.

@gjtorikian
Copy link

Dashes are definitely the convention in Ruby, so I believe html-proofer-mailto_awesome is what you want to go for here.

The rest of the plan looks great!

@fulldecent
Copy link
Owner Author

Thank you, I figured out how to get this on ruby gems. We are live!

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

3 participants