Ruby mogilefs-client 3.12.2
[ruby-mogilefs-client.git] / HACKING
blob349a94641c7cd8681d858f1bbd2655a809607b19
1 = Hacking mogilefs-client for Ruby
3 * The latest code is available via git:
4   - https://yhbt.net/mogilefs-client.git
5   - git://repo.or.cz/ruby-mogilefs-client
7 * Follow conventions set in existing code, don't add hard runtime
8   dependencies outside of the standard Ruby library.
10 * Do not hesitate to send plain-text(-only) email to the public list
11   at mailto:mogilefs-client-public@yhbt.net about anything not covered
12   in the documentation or mailing list archives.  General MogileFS
13   topics can go on the the mailing list at mailto:mogile@googlegroups.com
15 * Use "git format-patch" and "git send-email" for sending patches.
17 * Use "git request-pull" as a guideline for formatting pull-request emails.
19 * Test with the latest upstream MogileFS and Ruby versions.
21 * Integration tests exist for setting up a fresh MogileFS instance
22   with a single host and device using a SQLite backend if you
23   have "mogdbsetup", "mogilefsd", and "mogstored" in your PATH.
25 * Tests may be run in parallel using GNU make:
27   make -j6 test
29 * Generate a pre-release gem for distribution/testing:
31   rake gem