mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Merge pull request #37924 from itohiro73/improve_contributing_guide_for_rdoc
Improve contributing guide for RDoc [ci skip]
This commit is contained in:
commit
42111f85df
1 changed files with 2 additions and 2 deletions
|
@ -133,9 +133,9 @@ Contributing to the Rails Documentation
|
|||
Ruby on Rails has two main sets of documentation: the guides, which help you
|
||||
learn about Ruby on Rails, and the API, which serves as a reference.
|
||||
|
||||
You can help improve the Rails guides by making them more coherent, consistent, or readable, adding missing information, correcting factual errors, fixing typos, or bringing them up to date with the latest edge Rails.
|
||||
You can help improve the Rails guides or the API reference by making them more coherent, consistent, or readable, adding missing information, correcting factual errors, fixing typos, or bringing them up to date with the latest edge Rails.
|
||||
|
||||
To do so, make changes to Rails guides source files (located [here](https://github.com/rails/rails/tree/master/guides/source) on GitHub). Then open a pull request to apply your
|
||||
To do so, make changes to Rails guides source files (located [here](https://github.com/rails/rails/tree/master/guides/source) on GitHub) or RDoc comments in source code. Then open a pull request to apply your
|
||||
changes to the master branch.
|
||||
|
||||
When working with documentation, please take into account the [API Documentation Guidelines](api_documentation_guidelines.html) and the [Ruby on Rails Guides Guidelines](ruby_on_rails_guides_guidelines.html).
|
||||
|
|
Loading…
Reference in a new issue