Permalink
Fetching contributors…
Cannot retrieve contributors at this time
111 lines (92 sloc) 4.59 KB
dir = File.dirname(__FILE__)
require "#{dir}/page"
require "#{dir}/navbar"
class Developers < Page
def initialize
super(:page_title => "For Developers")
end
def promo
"images/be-an-erector-engineer.jpeg"
end
def body_content
h1 "Want to help develop Erector? Here's what to do."
h2 "Clone Erector from Github or create your own fork:"
pre <<END
git clone git://github.com/erector/erector.git
cd erector
END
h2 "Install gems:"
pre <<END
bundle install
END
h2 "Run specs:"
pre "rake"
h2 "Check out the available rake tasks:"
pre "rake -T"
h2 "Sign up for the mailing list:"
a "'erector' Google Group", :href => "http://groups.google.com/group/erector"
h2 "Watch the github repo at "
url "http://github.com/erector/erector"
h2 "Join the Pivotal Tracker project at "
url "http://www.pivotaltracker.com/projects/482"
h2 "Basic read-only git usage"
p "First, install git. Then download erector using git:"
pre "git clone git://github.com/erector/erector.git"
p "Generate a diff between what you have edited and what you have run git add on:"
pre "git diff"
p "Generate a diff between what you have run git add on and locally committed:"
pre "git diff --cached"
p "Commit locally (into your .git directory):"
pre "git commit -a"
p "You can update from the erector repository at github with:"
pre "git pull"
p "However, since you have checked out git read-only, you cannot push back your changes with:"
pre "git push"
p "Instead, mail a diff to the mailing list, or fork your own github repository and send a pull request."
h2 "Read/write access"
p "The following instructions assume you have been listed as a collaborator on the github pivotal erector project."
p "First, install git. Then:"
pre "git clone git@github.com:pivotal/erector.git"
p "To push your changes back to the main git repository:"
source_code :sh, <<END
git commit -a
git pull
# Deal with merge issues if any.
git push
END
p "To get other people's changes:"
pre "git pull"
h2 "Versioning and Release Policy"
ul do
li "Versions are of the form major.minor.tiny"
li "Tiny revisions fix bugs or documentation"
li "Minor revisions add API calls, or change behavior"
li "Minor revisions may also remove API calls, but these must be clearly announced in History.txt, with instructions on how to migrate "
li "Major revisions are about marketing more than technical needs. We will stay in major version 0 until we're happy taking the \"alpha\" label off it. And if we ever do a major overhaul of the API, especially one that breaks backwards compatibility, we will probably want to increment the major version."
li "Developers should attempt to add lines in History.txt to reflect their checkins. These should reflect feature-level changes, not just one line per checkin. The top section of History.txt is used as the Release Notes by the \"rake publish\" task and will appear on the RubyForge file page."
end
h2 "How to push a release"
ol do
li "Pick a version number. Either increment the major, minor, or tiny version from the previous version."
li %q{Look at History.txt and make sure the release notes are up to date. Put the version number and today's date on the top line (after the "==").}
li do
text "Put the new version number in "
code "VERSION.yml"
text " (not in "
code "erector.gemspec"
text "; that'll get changed on its own)"
end
li %q{Commit these changes, e.g. 'git commit -a'}
li %q{Run 'rake package' so that you can see whether the gem generation seems to work locally before proceeding to try to upload it to rubyforge (if you skip this step, the package will be generated when you run rake release)}
li "If you haven't done so before, run 'rubyforge setup' and 'rubyforge config' (for more details on these steps, see README.txt in the rubyforge gem)"
li "Run 'rake release VERSION=1.2.3'. (The parameter is to confirm you're releasing the version you intend to.)"
li "Run 'rake publish' cause the docs and site need to be updated, at least with the new version number."
li %q{Immediately go into History.txt and make a new section at the top. Since we won't yet know what the next version will be called, the new section will be noted by a single "==" at the top of the file.}
li do
text "Send email to "
a("erector Google Groups mailing list", :href => "mailto:erector@googlegroups.com")
text " announcing the new release."
end
end
end
end