aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source/contributing_to_ruby_on_rails.md
Commit message (Collapse)AuthorAgeFilesLines
* Docs: Update Development Dependencies InstallViktor Fonic2018-11-091-2/+21
| | | | | | | | | | | | | | | | | | | | | * Move all the testing related stuff to the contributing guide and redirect the reader to this guide once the installation process is finished as running tests is the logical next step. * Group documentation instructions by OS, not by gem * It eases the installation process and lessen the need to scroll through the guide * There's still a list of all additional services required for each of the gems above the instructions for each OS. * Also update a bit the instructions * Update some package names * Add `yarn` to the package list for Arch Linux and FreeBSD * Use `dnf` instead of `yum` for Fedora and CentOS * Advise the user to use `brew bundle` on macOS to lessen the maintenance burden for this OS and ease the process for the user. [ci skip]
* Merge pull request #34075 from hakusaro/guides-reference-leasesGannon McGibbon2018-10-091-6/+7
|\ | | | | Change contributing guide to suggest using safer force push
| * Change contributing guide to use safer force pushLucas Nicodemus2018-10-041-6/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit changes the contributing guide in rails to suggest using git with force-with-lease over typical force pushing. In practice, most rails contributors won't ever encounter a situation where updating their local fork could result in lost changes as a result of a force push. That being said, git is a complex tool and arcane flags like force-with-lease are indeed safer, and by promoting it in rails, there's a chance more people will discover it and use it in other contexts outside of rails. In just the same way that herd immunity works by most people being vaccinated, proliferating knowledge of force-with-lease should help nudge people towards using safer git commands in general. [ci skip]
* | Add documentation to run tests with specific seed [ci skip]Alberto Almagro2018-10-051-0/+20
|/ | | | | This commit documents how to run all tests or a single test file with a specific randomization seed.
* Improve phrasing of one sentence in the contributing guidePascal Lamouric2018-09-241-1/+1
|
* Correct spelling in "Contributing to Ruby on Rails" guide [ci skip]bogdanvlviv2018-09-201-1/+1
| | | | | | ambigity -> ambiguity Related to #33891
* Standardize git remote names.John Gorman2018-09-151-40/+12
|
* Update guide to mention code linters availablePrem Sichanugrist2018-08-151-2/+13
| | | | | | | Contributors can run RuboCop locally to catch code style error in Ruby code and npm lint task for `rails-ujs` CoffeeScript and JavaScript code. [skip ci]
* Rails guides are now served over httpsPaul McMahon2018-07-241-1/+1
| | | | | http links will be redirected to the https version, but still better to just directly link to the https version.
* Remove ineffective no-warnings flags from Contribute guideutilum2018-06-081-6/+0
| | | | This is not working. [ci skip]
* Added a lot of Oxford commasAnthony Crumley2018-05-101-4/+4
| | | | | | | [ci skip] A regular expression was used to find a lot of missing Oxford commas and add them. The regular expression was as follows. ", ([a-zA-Z0-9.\`:'\"]+ ){1,6}(or|and) "
* We usually do not use GH#1234 style in the CHANGELOGs [ci skip]Ryuta Kamizono2018-04-291-1/+1
|
* Clarification for noobs. (#31704)loothunter12018-01-231-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Update active_record_basics.md I made a bit of clarification for people, who are not familiar with SQL (pretty much like me). However, I don't know what tutorial for MySQL is better, so I haven't inserted a link yet. * [ci skip] For those who new to GitHub Added more instructions for contributing guides. Without them, it was somewhat confusing for me to find what I should actually do. * Update active_record_basics.md Fixed grammar and text wrapping as requested. * Update contributing_to_ruby_on_rails.md Revised instructions. * Update contributing_to_ruby_on_rails.md Typos * Update active_record_basics.md * [ci skip] Update active_record_basics Added a few links to SQL tutorials found on the net. Also, changed MySQL to SQL (or one of its extensions) - I think that it's a good compromise. * [ci skip] I think now it's more clear what to do. * [ci skip] Fixed strings [Rafael Mendonça França + loothunter1]
* emphasize working on existing issues/patches for newcomers [ci skip]Xavier Noria2017-12-171-1/+3
| | | | Thanks to @Datasnuten for the suggestion.
* Fix link Contributing Ruby on Rails [ci skip]Yoshiyuki Hirano2017-08-211-7/+7
| | | | | | | | | * Add Contributing to the Rails Code link. * Wiki link for Spanish is redirect. * The base branch of Polish repo is master. And Turkish is, too. * Unified expression `rails-dev-box` * The Clone url is wrong. * The mailing list url is old.
* Update Contributing to Ruby on Rails guide [ci skip]Yoshiyuki Hirano2017-08-211-1/+1
|
* Use ssl in guide and comment [ci skip]Yoshiyuki Hirano2017-08-191-2/+2
|
* explain why guide translations need a fork [ci skip]Xavier Noria2017-05-141-3/+4
|
* Drop the "Sanity Check" contributing stepMatthew Draper2017-04-091-10/+0
|
* Remove mentions and instructions for docrailsMatthew Draper2017-04-091-14/+2
| | | | It's been retired; all contributions now come in via PRs.
* Small grammar fixJon Moss2017-03-251-1/+1
| | | | | | Add apostrophe. [ci skip]
* Small grammar fixJon Moss2017-03-251-2/+2
| | | | | | Add necessary commas. [ci skip]
* Fix judgement spelling [ci skip]Carlos Gavino2017-01-281-1/+1
| | | | | `judgment` is the preferred form as Rails usually follows en-us spelling not en-gb.
* Mention ActiveRecord's config.example.ymlOlivier Lacan2017-01-191-4/+6
| | | | This will help people figure out what credentials and tables are required to run ActiveRecord specs.
* [ci skip] Fix typo in Guides: ContributingAlex Kitchens2016-10-171-1/+1
|
* Introduce a benchmark template [ci skip]Godfrey Chan2016-10-151-27/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This replaces boilerplate in the “benchmark your code” section of the contributors’ guide with an executable template. I also amended the text to encourage best practices and codified it in the template. For now this is only good for relatively self-contained changes that can be inlined into a simple script. In the future, this can be expanded to cover how to measure the difference between two commits. The output looks like this: ``` ==================================== Empty ===================================== Warming up -------------------------------------- blank? 225.963k i/100ms fast_blank? 238.147k i/100ms Calculating ------------------------------------- blank? 8.825M (± 6.4%) i/s - 44.063M in 5.014824s fast_blank? 9.311M (± 6.3%) i/s - 46.439M in 5.009153s Comparison: fast_blank?: 9310694.8 i/s blank?: 8824801.7 i/s - same-ish: difference falls within error ================================= Single Space ================================= Warming up -------------------------------------- blank? 56.581k i/100ms fast_blank? 232.774k i/100ms Calculating ------------------------------------- blank? 813.985k (±16.7%) i/s - 4.017M in 5.076576s fast_blank? 9.547M (± 5.2%) i/s - 47.719M in 5.013204s Comparison: fast_blank?: 9547414.0 i/s blank?: 813985.0 i/s - 11.73x slower ================================== Two Spaces ================================== Warming up -------------------------------------- blank? 58.265k i/100ms fast_blank? 244.056k i/100ms Calculating ------------------------------------- blank? 823.343k (±16.2%) i/s - 4.020M in 5.014213s fast_blank? 9.484M (± 4.9%) i/s - 47.347M in 5.005339s Comparison: fast_blank?: 9484021.6 i/s blank?: 823343.1 i/s - 11.52x slower =============================== Mixed Whitspaces =============================== Warming up -------------------------------------- blank? 53.919k i/100ms fast_blank? 237.103k i/100ms Calculating ------------------------------------- blank? 763.435k (±16.8%) i/s - 3.720M in 5.018029s fast_blank? 9.672M (± 5.8%) i/s - 48.369M in 5.019356s Comparison: fast_blank?: 9672467.2 i/s blank?: 763435.4 i/s - 12.67x slower =============================== Very Long String =============================== Warming up -------------------------------------- blank? 34.037k i/100ms fast_blank? 240.366k i/100ms Calculating ------------------------------------- blank? 409.731k (± 8.9%) i/s - 2.042M in 5.028235s fast_blank? 9.794M (± 4.3%) i/s - 49.035M in 5.016328s Comparison: fast_blank?: 9794225.2 i/s blank?: 409731.4 i/s - 23.90x slower ```
* bug report template for migrations (#26488)Girish Sonawane2016-09-151-0/+1
| | | * added bug report template for migrations
* add Active Job bug report templates to guide [ci skip]yuuji.yaginuma2016-09-031-0/+1
| | | | Follow up to #26362
* [ci skip] Update branch version in Contributing GuideAlex Kitchens2016-08-291-1/+1
| | | | | Since only Rails 4 and above are currently supported, this updates a 3-2-stable example to be consistent with the support standard.
* Merge pull request #25278 from mechanicles/fix-linkJon Moss2016-06-041-1/+1
|\ | | | | [ci skip] Fix link rubyonrails.org/core => http://rubyonrails.org/community
| * [ci skip] Fix link rubyonrails.org/core => http://rubyonrails.org/community.Santosh Wadghule2016-06-041-1/+1
| |
* | Grammar fixes for Contributing guideJon Moss2016-06-021-7/+7
|/ | | | | | | | | Not sure why #25239, but it had good changes, so I'm manually pulling in the changes. [Jon Moss, Rajat Bansal] [ci skip]
* Change http github links to https [ci skip]Mehmet Emin İNAÇ2016-05-081-4/+4
| | | | Follow up to 7d55c846f11a435a4c7aae58f99279a2b9dd8506
* [ci skip] Update 'Testing Active Record'yui-knk2016-02-141-1/+1
| | | | | | | | | Follow up 8c629bf463b47643712570d4511a68b9a3da1476. `bundle exec rake test` in 'activerecord' runs tests for * sqlite3 * mysql2 * postgresql
* .git added to https repo urlsVishnu Ks2016-02-021-5/+5
|
* git protocol replaced with httpsVishnu Ks2016-02-021-5/+5
|
* typo fix [ci skip] Prayag Verma2016-01-311-1/+1
| | | Spelling mistake - direcotry > directory
* remove legacy mysql from guides to match #22715Scott Bronson2016-01-091-1/+0
|
* fix links to code of conduct [ci skip]yuuji.yaginuma2015-12-111-1/+1
| | | | CoC text has been moved to the Rails website in 90bcb6d
* [ci skip] Add `Translating Rails Guides` to contributing_to_ruby_on_railsyui-knk2015-11-231-0/+36
| | | | | | | Docrails is private now (6cb1b6724c313c608cf4063fc22886faa19df9be), anyone who does not have access right to docrails can't read "Translating Rails Guides" in wiki of docrails. To prevent someone from giving up to translate, publish them on Rails Guide.
* Remove links to docrailsRafael Mendonça França2015-11-051-2/+2
| | | | docrails is a private repository now to avoid pull requests to it.
* Fix pluralization in docs [ci skip]Scott González2015-10-071-1/+1
|
* [ci skip] Add `:` before code blocks.yui-knk2015-09-251-1/+1
|
* typo fix [ci skip]amitkumarsuroliya2015-09-011-1/+1
| | | sub-project's should be sub-projects' at all places
* Add code of conduct to README.md and to contributing guide [ci skip]maclover72015-08-181-0/+3
|
* [ci skip] Add `bundle exec` to test run commandyui-knk2015-07-171-1/+1
|
* the key is that the behavior is incorrect [ci skip]Tony Miller2015-07-111-1/+1
|
* saying that "behaviour" "behaves" is kind of awkward, how about "works"Tony Miller2015-07-101-1/+1
|
* [ci skip] change sentence about reporting bugs in contributing guideTony Miller2015-07-101-1/+1
| | | | | | I think I know what this sentence is trying to say, but the sentence didn't really make sense, bugs don't fix things! How about this take on it? :sweat_smile:
* [ci skip] Add `bundle exec` to Running a Single Testyui-knk2015-07-081-1/+1
|