From f060fd54b106e6a43c74a977fa71d3d568796949 Mon Sep 17 00:00:00 2001 From: maclover7 Date: Tue, 1 Sep 2015 11:43:29 -0400 Subject: [PATCH] Add CONTRIBUTING.md [ci skip] --- CONTRIBUTING.md | 102 ++++++++++++++++++++++++++++++++++++++++++++++++ MIT-LICENSE | 2 +- README.md | 20 +++++----- 3 files changed, 113 insertions(+), 11 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..899f288b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,102 @@ +Contributing to Jbuilder +===================== + +[![Build Status](https://travis-ci.org/rails/jbuilder.svg?branch=master)]() +[![Gem Version](http://img.shields.io/gem/v/jbuilder.svg)]() +[![Code Climate](http://img.shields.io/codeclimate/github/rails/jbuilder.svg)]() +[![Dependencies Status](http://img.shields.io/gemnasium/rails/jbuilder.svg)]() + +Jbuilder is work of [many contributors](https://github.com/rails/jbuilder/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/rails/jbuilder/pulls), [propose features and discuss issues](https://github.com/rails/jbuilder/issues). + +#### Fork the Project + +Fork the [project on Github](https://github.com/rails/jbuilder) and check out your copy. + +``` +git clone https://github.com/contributor/jbuilder.git +cd jbuilder +git remote add upstream https://github.com/rails/jbuilder.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). + +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/jbuilder 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. diff --git a/MIT-LICENSE b/MIT-LICENSE index 46206da4..7d0363ee 100644 --- a/MIT-LICENSE +++ b/MIT-LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2011-2014 David Heinemeier Hansson, 37signals +Copyright (c) 2011-2015 David Heinemeier Hansson, 37signals Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the diff --git a/README.md b/README.md index f213c072..6bce5101 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,5 @@ # Jbuilder -[![Build Status](https://api.travis-ci.org/rails/jbuilder.svg)][travis] -[![Gem Version](http://img.shields.io/gem/v/jbuilder.svg)][gem] -[![Code Climate](http://img.shields.io/codeclimate/github/rails/jbuilder.svg)][codeclimate] -[![Dependencies Status](http://img.shields.io/gemnasium/rails/jbuilder.svg)][gemnasium] - -[travis]: https://travis-ci.org/rails/jbuilder -[gem]: https://rubygems.org/gems/jbuilder -[codeclimate]: https://codeclimate.com/github/rails/jbuilder -[gemnasium]: https://gemnasium.com/rails/jbuilder - Jbuilder gives you a simple DSL for declaring JSON structures that beats massaging giant hash structures. This is particularly helpful when the generation process is fraught with conditionals and loops. Here's a simple @@ -258,3 +248,13 @@ for MultiJson: require 'multi_json' MultiJson.use :yajl ``` + +## Contributing to Jbuilder + +Jbuilder is work of many contributors. You're encouraged to submit pull requests, propose +features and discuss issues. + +See [CONTRIBUTING](CONTRIBUTING.md). + +## License +Jbuilder is released under the [MIT License](http://www.opensource.org/licenses/MIT).