Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 51 lines (33 sloc) 1.91 kb
3dc0daa @bernerdschaefer Added note on contributing to edge datamapper. Modified new gemspec task...
bernerdschaefer authored
1 # NOTE: This is a work in progress. As of July 24, it applies only to dm-core.
2
3 # Contributing to Edge DataMapper
4
5 We have now implemented Hoe throughout the DataMapper suite, so there will be a
6 handful of new procedures for contributing to our git repositories. I'll give
7 you a run through of how to set up your machine, and then provide a few
8 commands that should be run before committing or pushing changes.
9
10 ## Installing and configuring Hoe
11
12 The first step is to install hoe. You'll need at least version 1.7.0.
13
14 (sudo) gem install hoe --include-dependencies
15
16 Now you'll need to configure hoe. You'll need to run this from inside of
17 dm-core, or one of the other DataMapper projects.
18
19 rake config_hoe
20
21 The only thing you should need to change is the exclude regular expression,
22 which needs to look like this:
23
24 exclude: !ruby/regexp /tmp$|CVS|\.svn|\.git|.+\.gemspec/
25
26 Now you have the correct setup for contributing.
27
28 ## Before committing changes
29
30 Before you commit changes, you must verify that `Manifest.txt` (the file which
31 contains the names of every file to be included in a gem release) and
32 `[project-name].gemspec` are up to date. We have create a rake task to make
33 this easy:
34
35 rake gemspec
36
37 This will check `Manifest.txt` (using Hoe's `rake check_manifest`) to ensure
38 there are no differences between the files in the project, and those listed in
39 the manifest. If there is a difference, it will display a warning and a list of
40 the differences in `diff` format.
41
42 If the changes in the diff are correct, then you can run the following command
43 to update the manifest.
44
45 rake check_manifest | patch
46
47 If there are files you do not want added to the manifest, then you should
48 remove the files from the project, and then run `rake gemspec` again.
49
50 If `rake gemspec` says it was successful, then you can proceed with committing
51 and pushing your changes.
Something went wrong with that request. Please try again.