Ruby microservices community practices

20 views
Skip to first unread message

Chris Beer

unread,
Jun 9, 2011, 4:48:27 PM6/9/11
to ruby-microservices
Here are some proposed practices for releasing Ruby implementations of
microservices.

First, the gems should reside under the "microservices" organization
of github [1]. Text documentation should be marked up using the
textile format.

The gem should contain a README with a brief description of the
specification, a link to the appropriate spec (and version), and a
brief section containing usage examples.

We prefer implementations to be licensed using the Apache Public
License v2.

Optionally, a TODO file may live in the root of the project containing
next steps for the gem implementation.

Gems should be documented using YARD-style method documentation.

Gems should be tested using rspec, and should include an rcov coverage
task.

For integration with the continuous integration server, include a
'hudson' task that runs the tests, generates documentation, and
coverage reports.

The Lockit gem contains a simple Rakefile [2] that you may want to use
as a template.

Gems should be versioned using Semantic Versioning, and released to
rubygems frequently.

[1] https://github.com/microservices
[2] https://github.com/microservices/lockit/blob/master/Rakefile
Reply all
Reply to author
Forward
0 new messages