favor require_relative to speed up loading
[kcar.git] / HACKING
blobd3d54f893fdb08cc27a64e063531cc64bcfe8f8c
1 == development dependencies
3 * GNU make - https://www.gnu.org/software/make/
4 * git - https://www.git-scm.com/
5 * ruby - https://www.ruby-lang.org/en/
7         git clone git://bogomips.org/kcar
9 == tests
11 * make test - run each test in a separate process (parallelize using -j)
13 For non-GNU users, GNU make may be installed as "gmake".
15 == test environment
17 N - specify the number of threads for *-mt targets (minitest parallelize_me!)
18 RUBY - specify an alternative ruby(1) runtime
19 V - set to 1 for verbose test output (may be mangled if multithreaded)
21 == installing from git
23 * make install-gem
25 == contact
27 We use git(7) and develop kcar on a public mailing list like git.git
28 developers do.  Please send patches via git-send-email(1) to the public
29 mailing list at <mailto:kcar-public@bogomips.org>.  Pull requests should be
30 formatted using git-request-pull(1).
32 All mail is archived publically at: https://bogomips.org/kcar-public/
33 and nntp://news.public-inbox.org/inbox.comp.lang.ruby.kcar
35 Anonymous contributions will always be welcome.
36 No subscription is necessary to post to the mailing list.
37 Please remember to Cc: all recipients as subscription is optional.