add configurable :fail_timeout for backends
[ruby-mogilefs-client.git] / HACKING
blob575c2022e81b8ac457800422f1996aae5b5ee9da
1 = Hacking mogilefs-client for Ruby
3 * The latest code is available via git:
4   - git://bogomips.org/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 Eric Wong at
11   mailto:normalperson@yhbt.net about anything not covered in
12   the documentation or mailing list archives.  General MogileFS
13   topics can go to the public mailing list at mailto:mogile@googlegroups.com
14   You may still email Wong directly if you do not trust the corporation
15   that hosts the public mailing list.
17 * Use "git format-patch" and "git send-email" for sending patches.
19 * Use "git request-pull" as a guideline for formatting pull-requests.
21 * Test with the latest upstream MogileFS and Ruby versions.
23 * Integration tests exist for setting up a fresh MogileFS instance
24   with a single host and device using a SQLite backend if you
25   have "mogdbsetup", "mogilefsd", and "mogstored" in your PATH.
27 * Setting MOG_TEST_TRACKERS= to a comma-delimited list of trackers
28   can enable additional integration tests against a live tracker
29   (with multiple devices/hosts).
31 * Tests may be run in parallel using GNU make:
33   make -j6 test