diff options
author | Xavier Noria <fxn@hashref.com> | 2013-03-28 18:04:32 +0100 |
---|---|---|
committer | Xavier Noria <fxn@hashref.com> | 2013-03-28 18:04:57 +0100 |
commit | b77b95eaa27a38ade8ddeb7c5b9a816cc41a1590 (patch) | |
tree | 28ef5c29d4cd34a54fd7312ff27053f8e2eaf5ca | |
parent | 3eebc143afd7a1d967fbf939e0f20a00a37a0337 (diff) | |
download | rails-b77b95eaa27a38ade8ddeb7c5b9a816cc41a1590.tar.gz rails-b77b95eaa27a38ade8ddeb7c5b9a816cc41a1590.tar.bz2 rails-b77b95eaa27a38ade8ddeb7c5b9a816cc41a1590.zip |
contrib guide: documents guidelines for running the test suite
-rw-r--r-- | guides/source/contributing_to_ruby_on_rails.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/guides/source/contributing_to_ruby_on_rails.md b/guides/source/contributing_to_ruby_on_rails.md index e1827ffac0..575168a775 100644 --- a/guides/source/contributing_to_ruby_on_rails.md +++ b/guides/source/contributing_to_ruby_on_rails.md @@ -217,6 +217,17 @@ Now get busy and add or edit code. You’re on your branch now, so you can write * Include tests that fail without your code, and pass with it. * Update the (surrounding) documentation, examples elsewhere, and the guides: whatever is affected by your contribution. +It is not customary in Rails to run the full test suite before pushing +changes. The railties test suite in particular takes a long time, and even +more if the source code is mounted in `/vagrant` as happens in the recommended +workflow with the [rails-dev-box](https://github.com/rails/rails-dev-box). + +As a compromise, test what your code obviously affects, and if the change is +not in railties run the whole test suite of the affected component. If all is +green that's enough to propose your contribution. We have [Travis CI](https +://travis-ci.org/) as a safety net for catching unexpected breakages +elsewhere. + TIP: Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Rails will generally not be accepted. ### Follow the Coding Conventions |