mirrors
/
rails
mirror of https://github.com/rails/rails
8
0
Fork 0
Code Issues Projects Releases Wiki Activity
rails/CONTRIBUTING.md

57 lines
3.9 KiB
Markdown
Raw Normal View History

Adding badges and logo to README and CONTRIBUTING page
2021-01-19 07:24:14 +08:00
[![Build Status](https://badge.buildkite.com/ab1152b6a1f6a61d3ea4ec5b3eece8d4c2b830998459c75352.svg?branch=main)](https://buildkite.com/rails/rails)
[![Code Triage Badge](https://www.codetriage.com/rails/rails/badges/users.svg)](https://www.codetriage.com/rails/rails)
[![Version](https://img.shields.io/gem/v/rails)](https://rubygems.org/gems/rails)
[![License](https://img.shields.io/github/license/rails/rails)](https://github.com/rails/rails)
Add specific bug reporting guidelines to contributing.md. [ci skip] Add boldface and bullets to make more readable. Make sentences declarative. Remove "you"s.
2015-12-02 02:02:35 +08:00
## How to contribute to Ruby on Rails
Oops, rdoc -> markdown. This reverts commit 5d95f3209fb2d6155ecd76c7692d0ac71a14726c.
2012-09-18 01:05:43 +08:00
Add specific bug reporting guidelines to contributing.md. [ci skip] Add boldface and bullets to make more readable. Make sentences declarative. Remove "you"s.
2015-12-02 02:02:35 +08:00
#### **Did you find a bug?**
refer to the contributing guide on how to create issues.
2013-03-18 22:12:15 +08:00
Make security policy more prominent in docs [ci skip]
2017-02-24 07:34:26 +08:00
* **Do not open up a GitHub issue if the bug is a security vulnerability
Fix 404 links on https://rubyonrails.org/ [ci-skip]
2021-12-17 01:26:34 +08:00
in Rails**, and instead to refer to our [security policy](https://rubyonrails.org/security).
Make security policy more prominent in docs [ci skip]
2017-02-24 07:34:26 +08:00
Add specific bug reporting guidelines to contributing.md. [ci skip] Add boldface and bullets to make more readable. Make sentences declarative. Remove "you"s.
2015-12-02 02:02:35 +08:00
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/rails/rails/issues).
Improve CONTRIBUTING.md Noting that we don't take feature requests or 'help me' stuff on the Issues tracker should cut down a ton on bad Issues.
2012-09-18 01:15:09 +08:00
Typo in Contributing.md documentation Just fixed a small typo in the documentation.
2016-01-07 07:34:41 +08:00
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/rails/rails/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
Add info about contributing to docs to CONTRIBUTING.md Encourage more people to contribute to Rails docs by mentioning it in the contribution guide.
2013-06-06 21:38:06 +08:00
Add specific bug reporting guidelines to contributing.md. [ci skip] Add boldface and bullets to make more readable. Make sentences declarative. Remove "you"s.
2015-12-02 02:02:35 +08:00
* If possible, use the relevant bug report templates to create the issue. Simply copy the content of the appropriate template into a .rb file, make the necessary changes to demonstrate the issue, and **paste the content into the issue description**:
Rename master to main in all code references
2021-01-20 04:43:24 +08:00
* [**Active Record** (models, database) issues](https://github.com/rails/rails/blob/main/guides/bug_report_templates/active_record_main.rb)
* [**Action Pack** (controllers, routing) issues](https://github.com/rails/rails/blob/main/guides/bug_report_templates/action_controller_main.rb)
* [**Generic template** for other issues](https://github.com/rails/rails/blob/main/guides/bug_report_templates/generic_main.rb)
Roll contrib guide link into feature request guidance
2012-09-18 02:29:35 +08:00
Updated links from http to https in guides, docs, etc
2019-03-08 19:36:16 +08:00
* For more detailed information on submitting a bug report and creating an issue, visit our [reporting guidelines](https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#reporting-an-issue).
the contributing guide should be mentioned upfront
2012-09-18 22:43:59 +08:00
Add specific bug reporting guidelines to contributing.md. [ci skip] Add boldface and bullets to make more readable. Make sentences declarative. Remove "you"s.
2015-12-02 02:02:35 +08:00
#### **Did you write a patch that fixes a bug?**
* Open a new GitHub pull request with the patch.
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
Updated links from http to https in guides, docs, etc
2019-03-08 19:36:16 +08:00
* Before submitting, please read the [Contributing to Ruby on Rails](https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html) guide to know more about coding conventions and benchmarks.
Add specific bug reporting guidelines to contributing.md. [ci skip] Add boldface and bullets to make more readable. Make sentences declarative. Remove "you"s.
2015-12-02 02:02:35 +08:00
Add notes on cosmetic patches
2016-05-14 03:03:50 +08:00
#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**
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 (read more about [our rationales behind this decision](https://github.com/rails/rails/pull/13771#issuecomment-32746700)).
Add specific bug reporting guidelines to contributing.md. [ci skip] Add boldface and bullets to make more readable. Make sentences declarative. Remove "you"s.
2015-12-02 02:02:35 +08:00
#### **Do you intend to add a new feature or change an existing one?**
Update the Rails mailing list URLs to new discuss discourse URL [ci skip]
2020-03-26 14:21:37 +08:00
* Suggest your change in the [rubyonrails-core mailing list](https://discuss.rubyonrails.org/c/rubyonrails-core) and start writing code.
Add specific bug reporting guidelines to contributing.md. [ci skip] Add boldface and bullets to make more readable. Make sentences declarative. Remove "you"s.
2015-12-02 02:02:35 +08:00
* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
Add note about ActiveSupport to CONTRIBUTING.md This kind of PRs are submitted often so it's worth mentioning here.
2022-11-08 21:42:02 +08:00
* We generally reject changes to Active Support core extensions. Those change should be proposed in the [Ruby issue tracker instead](https://bugs.ruby-lang.org/issues), as we don't want to conflict with future versions of Ruby.
Add specific bug reporting guidelines to contributing.md. [ci skip] Add boldface and bullets to make more readable. Make sentences declarative. Remove "you"s.
2015-12-02 02:02:35 +08:00
#### **Do you have questions about the source code?**
Update the Rails mailing list URLs to new discuss discourse URL [ci skip]
2020-03-26 14:21:37 +08:00
* Ask any question about how to use Ruby on Rails in the [rubyonrails-talk mailing list](https://discuss.rubyonrails.org/c/rubyonrails-talk).
Add specific bug reporting guidelines to contributing.md. [ci skip] Add boldface and bullets to make more readable. Make sentences declarative. Remove "you"s.
2015-12-02 02:02:35 +08:00
#### **Do you want to contribute to the Rails documentation?**
Updated links from http to https in guides, docs, etc
2019-03-08 19:36:16 +08:00
* Please read [Contributing to the Rails Documentation](https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#contributing-to-the-rails-documentation).
Add specific bug reporting guidelines to contributing.md. [ci skip] Add boldface and bullets to make more readable. Make sentences declarative. Remove "you"s.
2015-12-02 02:02:35 +08:00
Adjust link to only include 'the team' rather than 'join the team' as the former suggests it's a link to get on a list
2020-09-20 03:20:09 +08:00
Ruby on Rails is a volunteer effort. We encourage you to pitch in and join [the team](https://contributors.rubyonrails.org)!
show love to contributors
2012-09-18 06:32:56 +08:00
Follow-up to #16097 [ci skip] Even if this is not exactly the same, let's add a new-line character instead of two spaces. While it's specified in the Markdown specs that adding spaces at the end of the line creates a break-line tag, this is a brittle approach as people may remove them saving the file on certain editors.
2014-07-18 17:51:36 +08:00
Thanks! :heart: :heart: :heart:
the contributing guide should be mentioned upfront
2012-09-18 22:43:59 +08:00
Rails Team