Merge pull request #204 from maclover7/contributing

Add CONTRIBUTING.md

CONTRIBUTING.md

@@ -1,17 +1,53 @@
-Thanks for taking the time to contribute to jquery-rails! Please
-take a moment to read the following brief guidelines to help streamline
-the merging process.
+Contributing to jquery-rails
+=====================
 
-## Updating jQuery
+[![Build Status](https://travis-ci.org/rails/jquery-rails.svg?branch=master)](https://travis-ci.org/rails/jquery-rails)
+
+jquery-rails is work of [many contributors](https://github.com/rails/jquery-rails/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/rails/jquery-rails/pulls), [propose features and discuss issues](https://github.com/rails/jquery-rails/issues).
+
+#### Updating jQuery
 
 If the jquery or jquery-ui scripts are outdated (i.e. maybe a new version of jquery was released yesterday), feel free to open an issue and prod us to get that thing updated. However, for security reasons, we won't be accepting pull requests with updated jquery or jquery-ui scripts.
 
-## Changes to jquery_ujs.js
+#### Changes to jquery_ujs.js
 
 **If it's an issue pertaining to the jquery-ujs javascript, please
 report it to the [rails/jquery-ujs project](https://github.com/rails/jquery-ujs/issues).**
 
-## Tests
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/rails/jquery-rails) and check out your copy.
+
+```
+git clone https://github.com/contributor/jquery-rails.git
+cd jquery-rails
+git remote add upstream https://github.com/rails/jquery-rails.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake test
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [test](test).
+
+#### Testing
 
 This is a gem that simply includes jQuery and jQuery UJS into the Rails
 asset pipeline. The asset pipeline functionality is well tested within the
@@ -29,8 +65,68 @@ If you're making changes to the actual gem, run the tests as follows:
 2. Install the gems: `bundle install`
 
 3. Change the jquery-rails gem in the Gemfile to use your local
-version of the gem with your updates: `gem 'rspec-rails', :path => '../path/to/jquery-rails'`
+version of the gem with your updates: `gem 'jquery-rails', :path => '../path/to/jquery-rails'`
 
 4. Update your bundled jquery-rails gem: `bundle update jquery-rails`
 
 5. Run the tests: `bundle exec rspec spec/`
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix.
+
+Make sure that `bundle exec rake test` completes without errors.
+
+#### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to https://github.com/contributor/jquery-rails and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+#### Check on Your Pull Request
+
+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.
+
+#### Be Patient
+
+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!
+
+#### Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

README.md

@@ -43,16 +43,20 @@ For jQuery UI, we recommend the [jquery-ui-rails](https://github.com/joliss/jque
 *As of v3.0, jquery-rails no longer includes jQuery UI. Use the
 jquery-ui-rails gem above.*
 
-## Contributing
+## Contributing to jquery-rails
 
-Feel free to open an issue ticket if you find something that could be improved. A couple notes:
+jquery-rails is work of many contributors. You're encouraged to submit pull requests, propose
+features and discuss issues.
 
 * If it's an issue pertaining to the jquery-ujs javascript, please report it to the [jquery-ujs project](https://github.com/rails/jquery-ujs).
 
 * If the jQuery scripts are outdated (i.e. maybe a new version of jquery was released yesterday), feel free to open an issue and prod us to get that thing updated. However, for security reasons, we won't be accepting pull requests with updated jQuery scripts.
 
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## License
+jquery-rails is released under the [MIT License](MIT-LICENSE).
+
 ## Acknowledgements
 
 Many thanks are due to all of [the jquery-rails contributors](https://github.com/rails/jquery-rails/graphs/contributors). Special thanks to [JangoSteve](http://github.com/JangoSteve) for tirelessly answering questions and accepting patches, and the [Rails Core Team](https://github.com/organizations/rails/teams/617) for making jquery-rails an official part of Rails 3.1.
-
-Copyright [André Arko](http://arko.net), released under the MIT License.