← Back
Editing: page-CONTRIBUTING_md.ri
U:RDoc::TopLevel[ i I"CONTRIBUTING.md:ETcRDoc::Parser::Markdowno:RDoc::Markup::Document: @parts[9S:RDoc::Markup::Heading: leveli: textI"Contributing to Rack;To: RDoc::Markup::Paragraph;[I"[Rack is work of {hundreds of contributors}[https://github.com/rack/rack/graphs/contributors]. You're encouraged to submit {pull requests}[https://github.com/rack/rack/pulls], {propose features and discuss issues}[https://github.com/rack/rack/issues]. When in doubt, post to the {rack-devel}[http://groups.google.com/group/rack-devel] mailing list.;TS; ; i ; I"Fork the Project;To; ;[I"XFork the {project on Github}[https://github.com/rack/rack] and check out your copy.;To:RDoc::Markup::Verbatim;[I"xgit clone https://github.com/contributor/rack.git cd rack git remote add upstream https://github.com/rack/rack.git ;T: @format0S; ; i ; I"Create a Topic Branch;To; ;[I"]Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.;To; ;[I"Tgit checkout master git pull upstream master git checkout -b my-feature-branch ;T;0S; ; i ; I""Bundle Install and Quick Test;To; ;[I"?Ensure that you can build the project and run quick tests.;To; ;[I":bundle install --without extra bundle exec rake test ;T;0S; ; i ; I"Running All Tests;To; ;[I" Install all dependencies.;To; ;[I"bundle install ;T;0o; ;[I"Run all tests.;To; ;[I"rake test ;T;0o; ;[I"XThe test suite has no dependencies outside of the core Ruby installation and bacon.;To; ;[I"=Some tests will be skipped if a dependency is not found.;To; ;[I"0To run the test suite completely, you need:;To:RDoc::Markup::List: @type: BULLET: @items[o:RDoc::Markup::ListItem: @label0;[o; ;[I" fcgi;To;;0;[o; ;[I" dalli;To;;0;[o; ;[I" thin;To; ;[I"cTo test Memcache sessions, you need memcached (will be run on port 11211) and dalli installed.;TS; ; i ; I"Write Tests;To; ;[I"xTry to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.;To; ;[I"fWe definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.;TS; ; i ; I"Write Code;To; ;[I"'Implement your feature or bug fix.;To; ;[I"TMake sure that <code>bundle exec rake fulltest</code> completes without errors.;TS; ; i ; I"Write Documentation;To; ;[I"ADocument any external behavior in the {README}[README.rdoc].;TS; ; i ; I"Update Changelog;To; ;[I"-Add a line to {CHANGELOG}[CHANGELOG.md].;TS; ; i ; I"Commit Changes;To; ;[I"5Make sure git knows your name and email address:;To; ;[I"hgit config --global user.name "Your Name" git config --global user.email "contributor@example.com" ;T;0o; ;[I"^Writing good commit logs is important. A commit log should describe what changed and why.;To; ;[I" git add ... git commit ;T;0S; ; i ; I" Push;To; ;[I"'git push origin my-feature-branch ;T;0S; ; i ; I"Make a Pull Request;To; ;[I"�Go to https://github.com/contributor/rack and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.;TS; ; i ; I" Rebase;To; ;[I"QIf you've been working on a change for a while, rebase with upstream/master.;To; ;[I"Xgit fetch upstream git rebase upstream/master git push origin my-feature-branch -f ;T;0S; ; i ; I"Make Required Changes;To; ;[I";Amend your previous commit and force push the changes.;To; ;[I"=git commit --amend git push origin my-feature-branch -f ;T;0S; ; i ; I" Check on Your Pull Request;To; ;[I"�Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.;TS; ; i ; I"Be Patient;To; ;[I"�It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!;TS; ; i ; I"Thank You;To; ;[I"`Please do know that we really appreciate and value your time and work. We love you, really.;T: @file@:0@omit_headings_from_table_of_contents_below0
Save File
Cancel