diff options
author | Steve Klabnik <steve@steveklabnik.com> | 2013-08-26 13:57:03 -0700 |
---|---|---|
committer | Steve Klabnik <steve@steveklabnik.com> | 2013-08-26 13:57:03 -0700 |
commit | 55870cd8ddab26149b8383651b6ef6bf68c404b2 (patch) | |
tree | e711673327b7941e79fa08df2d9035b5478bd1bb /guides | |
parent | a57416cc498066604be7f55abe73596b3ef7df7b (diff) | |
download | rails-55870cd8ddab26149b8383651b6ef6bf68c404b2.tar.gz rails-55870cd8ddab26149b8383651b6ef6bf68c404b2.tar.bz2 rails-55870cd8ddab26149b8383651b6ef6bf68c404b2.zip |
Add note about features vs. bugs.
Sometimes people ask what makes a feature and what makes a bug, so
let's clarify that so we can show it to people later.
Diffstat (limited to 'guides')
-rw-r--r-- | guides/source/contributing_to_ruby_on_rails.md | 25 |
1 files changed, 22 insertions, 3 deletions
diff --git a/guides/source/contributing_to_ruby_on_rails.md b/guides/source/contributing_to_ruby_on_rails.md index 17fdb74163..fc6b2f992a 100644 --- a/guides/source/contributing_to_ruby_on_rails.md +++ b/guides/source/contributing_to_ruby_on_rails.md @@ -46,9 +46,28 @@ WARNING: Please do not report security vulnerabilities with public GitHub issue ### What about Feature Requests? -Please don't put "feature request" items into GitHub Issues. If there's a new feature that you want to see added to Ruby on Rails, you'll need to write the code yourself - or convince someone else to partner with you to write the code. Later in this guide you'll find detailed instructions for proposing a patch to Ruby on Rails. If you enter a wishlist item in GitHub Issues with no code, you can expect it to be marked "invalid" as soon as it's reviewed. - -If you'd like feedback on an idea for a feature before doing the work for make a patch, please send an email to the [rails-core mailing list](https://groups.google.com/forum/?fromgroups#!forum/rubyonrails-core). You might get no response, which means that everyone is indifferent. You might find someone who's also interested in building that feature. You might get a "This won't be accepted." But it's the proper place to discuss new ideas. GitHub Issues are not a particularly good venue for the sometimes long and involved discussions new features require. +Please don't put "feature request" items into GitHub Issues. If there's a new +feature that you want to see added to Ruby on Rails, you'll need to write the +code yourself - or convince someone else to partner with you to write the code. +Later in this guide you'll find detailed instructions for proposing a patch to +Ruby on Rails. If you enter a wishlist item in GitHub Issues with no code, you +can expect it to be marked "invalid" as soon as it's reviewed. + +Sometimes, the line between 'bug' and 'feature' is a hard one to draw. +Generally, a feature is anything that adds new behavior, while a bug is +anything that fixes already existing behavior that is mis-behaving. Sometimes, +the core team will have to make a judgement call. That said, the distinction +generally just affects which release your patch will get in to; we love feature +submissions! They just won't get backported to maintenance branches. + +If you'd like feedback on an idea for a feature before doing the work for make +a patch, please send an email to the [rails-core mailing +list](https://groups.google.com/forum/?fromgroups#!forum/rubyonrails-core). You +might get no response, which means that everyone is indifferent. You might find +someone who's also interested in building that feature. You might get a "This +won't be accepted." But it's the proper place to discuss new ideas. GitHub +Issues are not a particularly good venue for the sometimes long and involved +discussions new features require. Setting Up a Development Environment ------------------------------------ |