v6.1.4
Veja mais em rubyonrails.org: Mais Ruby on Rails

Contribuindo para o Ruby on Rails

Esse guia aborda algumas maneiras de como você pode se tornar uma parte do desenvolvimento contínuo do Ruby on Rails.

Depois de ler este guia, você saberá:

Ruby on Rails não é um "framework de qualquer um." Ao longo dos anos, milhares de pessoas contribuíram para o Ruby on Rails, desde as mais simples implementações até as maiores mudanças na arquitetura ou documentação - tudo isso com o objetivo de fazer um Ruby on Rails melhor para todos. Mesmo que você ainda não se sinta pronto para escrever um código ou documentação, existem várias outras maneiras pelas quais você pode contribuir, desde relatar problemas até testar patches.

Como mencionado em Rails'README, espera-se que todos que interajam no Rails e nas bases de código de seus sub-projetos, issue trackers, chat rooms e listas de discussão sigam o código de conduta do Rails.

1 Relatando uma Issue

O Ruby on Rails utiliza o GitHub Issue Tracking para rastrear problemas (principalmente bugs e contribuições de novo código). Se você encontrou um bug no Ruby on Rails, este é o lugar por onde começar. Você precisará criar uma conta (gratuita) no GitHub para poder enviar uma issue, fazer comentários nelas, ou criar pull requests.

Os bugs na versão mais recente do Ruby on Rails provavelmente receberão mais atenção. Além disso, a equipe principal do Rails está sempre interessada no feedback daqueles que podem tirar um tempo para testar o edge Rails (o código para a versão do Rails que está atualmente em desenvolvimento). Posteriormente neste guia, você irá descobrirá como obter o edge Rails para testes.

1.1 Criando um aviso de Bug

Se você encontrou um problema no Ruby on Rails que não é um risco de segurança, faça um pesquisa no GitHub em Issues, caso já tenha sido relatado. Se você não conseguir encontrar nenhuma issue aberta no GitHub que resolva o problema que encontrou, seu próximo passo será abrir uma nova. (Consulte a próxima seção para relatar problemas de segurança.)

Seu relatório de issue deve conter, no mínimo, um título e uma descrição clara do problema. Você deve incluir o máximo possível de informações relevantes e, pelo menos, postar um exemplo de código que demonstre o problema. Seria ainda melhor se você pudesse incluir um teste de unidade que mostra como o comportamento esperado não está ocorrendo. Seu objetivo deve ser tornar mais fácil para você - e para outros - reproduzir o bug e descobrir um correção.

Então, não tenha muitas esperanças! A menos que você tenha um tipo de bug "Código Vermelho, Estado Crítico, o Mundo está Chegando ao Fim", você está criando este relatório de issue na esperança de que outras pessoas com o mesmo problema possam colaborar com você para resolvê-lo. Não espere que o relatório de issue veja automaticamente qualquer atividade ou que outras pessoas corram para corrigí-lo. A criação de uma issue como essa é principalmente para ajudar a si mesmo a começar a corrigir o problema e para que outras pessoas confirmem com um comentário "Também estou tendo este problema".

1.2 Crie um Caso de Teste Executável

Ter uma maneira de reproduzir seu problema será muito útil para que outras pessoas ajudem a confirmar, investigar e, por fim, corrigir seu problema. Você pode fazer isso fornecendo um caso de teste executável. Para facilitar esse processo, preparamos vários modelos de relatório de bug para você utilizar como ponto de partida:

  • Template para problemas de Active Record (models, database): gem / main
  • Template para testar problemas de Active Record (migration): gem / main
  • Template para problemas de Action Pack (controllers, routing): gem / main
  • Template para problemas de Active Job: gem / main
  • Template para problemas de Active Storage: gem / main
  • Template para problemas de Action Mailbox: gem / main
  • Template genérico para outros problemas: gem / main

Esses templates incluem um código padrão (boilerplate) para configurar um caso de teste tanto para uma versão estável do Rails (*_gem.rb) quanto para o edge Rails (*_main.rb).

Copie o conteúdo do template apropriado para um arquivo .rb e faça as alterações necessárias para demonstrar o problema. Você pode executá-lo rodando ruby nome_do_arquivo.rb no seu terminal. Se tudo correr bem, você verá que seu caso de teste falhou.

Você pode então compartilhar seu caso de teste executável como um gist, ou colar o conteúdo na descrição da issue.

1.3 Tratamento Especial para Questões de Segurança

Não relate vulnerabilidades de segurança com relatórios públicos de issue do GitHub. A página de política de segurança do Rails detalha o procedimento a seguir para questões de segurança.

1.4 E quanto às Solicitações de Funcionalidade (Feature Requests)?

Por favor, não coloque itens de feature request nas issues do GitHub. Se houver uma nova feature que você deseja ver adicionada ao Ruby on Rails, você precisará escrever o código por conta própria - ou convencer alguém a fazer uma parceria com você para escrever o código. Posteriormente neste guia, você encontrará instruções detalhadas para propor um patch para o Ruby on Rails. Se você inserir um item que você deseja nas Issues do GitHub sem código, pode esperar que ele será marcado como "inválido" assim que for revisado.

Às vezes, é difícil de traçar a linha entre 'bug' e 'feature'. Normalmente, a feature é qualquer coisa que adiciona um novo comportamento, enquanto um bug é qualquer coisa que causa um comportamento incorreto. Às vezes, a equipe principal terá que fazer um julgamento. Dito isso, a distinção geralmente afeta apenas em qual versão seu patch entrará; nós amamos submissões de features! Elas simplesmente não serão transportadas para as branches de manutenção.

Se você deseja obter feedback sobre uma ideia de feature antes de começá-la e fazer um patch, envie um email para a lista de discussão do rails-core. Você pode não receber resposta, o que significa que todos são indiferentes. Você pode encontrar alguém que também esteja interessado em criar essa feature. Você pode receber um "Isso não será aceito". Mas é o lugar certo para discutir novas ideias. As issues do GitHub não são um local particularmente bom para as discussões às vezes longas e complicadas que as novas features exigem.

2 Ajudando a Resolver Issues Existentes

Como uma próxima etapa além de relatar issues, você pode ajudar a equipe principal a resolver as existentes fornecendo feedback sobre elas. Se você é novo no desenvolvimento do núcleo do Rails, essa pode ser uma ótima maneira de dar os primeiros passos, você irá se familiarizar com a base de código e os processos.

Se você verificar a lista de issues em Issues do GitHub, você encontrará muitas issues que já requerem atenção. O que você pode fazer para ajudar? Bastante coisa, na verdade:

2.1 Verificar Bug Reports

Para começar, ajuda apenas verificar os relatórios de bugs. Você pode reproduzir a issue relatada em seu próprio computador? Nesse caso, você pode adicionar um comentário à issue dizendo que está vendo a mesma coisa.

Se uma issue for muito vaga, você pode ajudar a restringí-la a algo mais específico? Talvez você possa fornecer informações adicionais para ajudar a reproduzir um bug ou ajudar eliminando etapas desnecessárias para demonstrar o problema.

Se você encontrar um relatório de bug sem um teste, é muito útil contribuir com um teste de falha. Essa também é uma ótima forma de começar a explorar o código-fonte: examinar os arquivos de testes irá te ensinar a escrever mais testes. Novos testes são melhor contribuídos na forma de um patch, como explicado mais tarde na seção "Contribuindo com o Código Rails"

Qualquer coisa que você possa fazer para tornar os relatórios de bugs mais sucintos ou mais fáceis de reproduzir ajuda as pessoas a tentarem escrever código para corrigir esses bugs - independentemente de você mesmo acabar escrevendo o código ou não.

2.2 Testar Patches

Você também pode ajudar examinando pull requests que foram enviados ao Ruby on Rails via GitHub. Para aplicar as alterações de alguém, você precisa primeiro criar uma branch dedicada:

$ git checkout -b testing_branch

Então, você pode usar a branch remota da pessoa que fez o pull request para atualizar sua base código. Por exemplo, digamos que o usuário JohnSmith tenha feito um fork e enviado para a branch "orange" localizada em https://github.com/JohnSmith/rails.

$ git remote add JohnSmith https://github.com/JohnSmith/rails.git
$ git pull JohnSmith orange

Depois de aplicar a branch, teste-a! Aqui estão algumas coisa a se atentar:

  • A alteração realmente funciona?
  • Você está satisfeito com os testes? Você pode acompanhar o que estão testando? Há algum teste faltando?
  • Possui a cobertura de documentação adequada? A documentação deve ser atualizada em algum outro lugar?
  • Você está satisfeito com a implementação? Você pode pensar em uma maneira mais agradável ou rápida de implementar parte da alteração?

Uma vez que você estiver satisfeito com o fato de que o pull request possui uma boa alteração, comente na issue do GitHub indicando sua aprovação. Seu comentário deve indicar que você gostou da mudança e o que você gostou nela. Algo como:

Eu gostei da forma como você reestruturou o código em generate_finder_sql - muito melhor. Os testes também parecem bons.

Se o seu comentário for apenas "+1", é provável que outros revisores não o levem muito a sério. Mostre que você dedicou um tempo para revisar o pull request.

3 Contribuindo com a documentação do Rails

O Ruby on Rails possui dois conjuntos principais de documentação: os guias, que te ajudam a aprender sobre Ruby on Rails, e a API, que serve como referência.

Você pode ajudar a melhorar os guias do Rails ou a referência da API tornando-os mais coerentes, consistentes ou legíveis, adicionando informações ausentes, corrigindo erros factuais, corrigindo erros de digitação ou atualizando-os com os Rails mais recentes.

Para isso, faça alterações aos arquivos-fonte dos guias do Rails (localizados aqui no GitHub) ou comentários RDoc no código fonte. Então abra um Pull Request para aplicar suas mudanças na branch principal (main).

Ao trabalhar com a documentação, leve em consideração as Diretrizes de Documentação da API e as Diretrizes dos guias Ruby on Rails.

Para alterações na documentação, o título da solicitação pull deve incluir [ci skip]. Isso irá ignorar a execução do conjunto de testes, ajudando-nos a reduzir nossos custos de servidor. Lembre-se de que você só deve pular o CI (integração contínua) quando sua alteração tocar exclusivamente na documentação.

4 Translating Rails Guides

We are happy to have people volunteer to translate the Rails guides. Just follow these steps:

  • Fork https://github.com/rails/rails.
  • Add a source folder for your own language, for example: guides/source/it-IT for Italian.
  • Copy the contents of guides/source into your own language directory and translate them.
  • Do NOT translate the HTML files, as they are automatically generated.

Note that translations are not submitted to the Rails repository. As detailed above, your work happens in a fork. This is so because in practice documentation maintenance via patches is only sustainable in English.

To generate the guides in HTML format you will need to install the guides dependencies, cd into the guides directory, and then run (e.g. for it-IT):

# only install gems necessary for the guides. To undo run: bundle config --delete without
$ bundle install --without job cable storage ujs test db
$ cd guides/
$ bundle exec rake guides:generate:html GUIDES_LANGUAGE=it-IT

This will generate the guides in an output directory.

The Redcarpet Gem doesn't work with JRuby.

Translation efforts we know about (various versions):

5 Contributing to the Rails Code

5.1 Setting Up a Development Environment

To move on from submitting bugs to helping resolve existing issues or contributing your own code to Ruby on Rails, you must be able to run its test suite. In this section of the guide, you'll learn how to set up the tests on your own computer.

5.1.1 The Easy Way

The easiest and recommended way to get a development environment ready to hack is to use the rails-dev-box.

5.1.2 The Hard Way

In case you can't use the Rails development box, see this other guide.

5.2 Clone the Rails Repository

To be able to contribute code, you need to clone the Rails repository:

$ git clone https://github.com/rails/rails.git

and create a dedicated branch:

$ cd rails
$ git checkout -b my_new_branch

It doesn't matter much what name you use, because this branch will only exist on your local computer and your personal repository on GitHub. It won't be part of the Rails Git repository.

5.3 Bundle install

Install the required gems.

$ bundle install

5.4 Running an Application Against Your Local Branch

In case you need a dummy Rails app to test changes, the --dev flag of rails new generates an application that uses your local branch:

$ cd rails
$ bundle exec rails new ~/my-test-app --dev

The application generated in ~/my-test-app runs against your local branch and in particular sees any modifications upon server reboot.

5.5 Write Your Code

Now get busy and add/edit code. You're on your branch now, so you can write whatever you want (make sure you're on the right branch with git branch -a). But if you're planning to submit your change back for inclusion in Rails, keep a few things in mind:

  • Get the code right.
  • Use Rails idioms and helpers.
  • 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.

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).

5.5.1 Follow the Coding Conventions

Rails follows a simple set of coding style conventions:

  • Two spaces, no tabs (for indentation).
  • No trailing whitespace. Blank lines should not have any spaces.
  • Indent and no blank line after private/protected.
  • Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
  • Prefer &&/|| over and/or.
  • Prefer class << self over self.method for class methods.
  • Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
  • Use a = b and not a=b.
  • Use assert_not methods instead of refute.
  • Prefer method { do_stuff } instead of method{do_stuff} for single-line blocks.
  • Follow the conventions in the source you see used already.

The above are guidelines - please use your best judgment in using them.

Additionally, we have RuboCop rules defined to codify some of our coding conventions. You can run RuboCop locally against the file that you have modified before submitting a pull request:

$ rubocop actionpack/lib/action_controller/metal/strong_parameters.rb
Inspecting 1 file
.

1 file inspected, no offenses detected

For rails-ujs CoffeeScript and JavaScript files, you can run npm run lint in actionview folder.

5.6 Benchmark Your Code

For changes that might have an impact on performance, please benchmark your code and measure the impact. Please share the benchmark script you used as well as the results. You should consider including this information in your commit message, which allows future contributors to easily verify your findings and determine if they are still relevant. (For example, future optimizations in the Ruby VM might render certain optimizations unnecessary.)

It is very easy to make an optimization that improves performance for a specific scenario you care about but regresses on other common cases. Therefore, you should test your change against a list of representative scenarios. Ideally, they should be based on real-world scenarios extracted from production applications.

You can use the benchmark template as a starting point. It includes the boilerplate code to set up a benchmark using the benchmark-ips gem. The template is designed for testing relatively self-contained changes that can be inlined into the script.

5.7 Running Tests

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 takes an especially long time if the source code is mounted in /vagrant as happens in the recommended workflow with the 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 tests are passing, that's enough to propose your contribution. We have Buildkite as a safety net for catching unexpected breakages elsewhere.

5.7.1 Entire Rails:

To run all the tests, do:

$ cd rails
$ bundle exec rake test
5.7.2 For a Particular Component

You can run tests only for a particular component (e.g. Action Pack). For example, to run Action Mailer tests:

$ cd actionmailer
$ bundle exec rake test
5.7.3 For a Specific Directory

If you want to run the tests located in a specific directory use the TEST_DIR environment variable. For example, this will run the tests in the railties/test/generators directory only:

$ cd railties
$ TEST_DIR=generators bundle exec rake test
5.7.4 For a Specific File

You can run the tests for a particular file by using:

$ cd actionview
$ bundle exec ruby -w -Itest test/template/form_helper_test.rb
5.7.5 Running a Single Test

You can run a single test through ruby. For instance:

$ cd actionmailer
$ bundle exec ruby -w -Itest test/mail_layout_test.rb -n test_explicit_class_layout

The -n option allows you to run a single method instead of the whole file.

5.7.6 Running Tests with a Specific Seed

Test execution is randomized with a randomization seed. If you are experiencing random test failures you can more accurately reproduce a failing test scenario by specifically setting the randomization seed.

Running all tests for a component:

$ cd actionmailer
$ SEED=15002 bundle exec rake test

Running a single test file:

$ cd actionmailer
$ SEED=15002 bundle exec ruby -w -Itest test/mail_layout_test.rb
5.7.7 Running Tests in Serial

Action Pack and Action View unit tests run in parallel by default. If you are experiencing random test failures you can set the randomization seed and let these unit tests run in serial by setting PARALLEL_WORKERS=1

$ cd actionview
$ PARALLEL_WORKERS=1 SEED=53708 bundle exec ruby -w -Itest test/template/test_case_test.rb
5.7.8 Testing Active Record

First, create the databases you'll need. You can find a list of the required table names, usernames, and passwords in activerecord/test/config.example.yml.

For MySQL and PostgreSQL, it is sufficient to run:

$ cd activerecord
$ bundle exec rake db:mysql:build

Or:

$ cd activerecord
$ bundle exec rake db:postgresql:build

This is not necessary for SQLite3.

This is how you run the Active Record test suite only for SQLite3:

$ cd activerecord
$ bundle exec rake test:sqlite3

You can now run the tests as you did for sqlite3. The tasks are respectively:

$ bundle exec rake test:mysql2
$ bundle exec rake test:postgresql

Finally,

$ bundle exec rake test

will now run the three of them in turn.

You can also run any single test separately:

$ ARCONN=sqlite3 bundle exec ruby -Itest test/cases/associations/has_many_associations_test.rb

To run a single test against all adapters, use:

$ bundle exec rake TEST=test/cases/associations/has_many_associations_test.rb

You can invoke test_jdbcmysql, test_jdbcsqlite3 or test_jdbcpostgresql also. See the file activerecord/RUNNING_UNIT_TESTS.rdoc for information on running more targeted database tests.

5.8 Warnings

The test suite runs with warnings enabled. Ideally, Ruby on Rails should issue no warnings, but there may be a few, as well as some from third-party libraries. Please ignore (or fix!) them, if any, and submit patches that do not issue new warnings.

5.9 Updating the CHANGELOG

The CHANGELOG is an important part of every release. It keeps the list of changes for every Rails version.

You should add an entry to the top of the CHANGELOG of the framework that you modified if you're adding or removing a feature, committing a bug fix, or adding deprecation notices. Refactorings and documentation changes generally should not go to the CHANGELOG.

A CHANGELOG entry should summarize what was changed and should end with the author's name. You can use multiple lines if you need more space and you can attach code examples indented with 4 spaces. If a change is related to a specific issue, you should attach the issue's number. Here is an example CHANGELOG entry:

*   Summary of a change that briefly describes what was changed. You can use multiple
    lines and wrap them at around 80 characters. Code examples are ok, too, if needed:

        class Foo
          def bar
            puts 'baz'
          end
        end

    You can continue after the code example and you can attach issue number.

    Fixes #1234.

    *Your Name*

Your name can be added directly after the last word if there are no code examples or multiple paragraphs. Otherwise, it's best to make a new paragraph.

5.10 Updating the Gemfile.lock

Some changes require the dependencies to be upgraded. In these cases make sure you run bundle update to get the right version of the dependency and commit the Gemfile.lock file within your changes.

5.11 Commit Your Changes

When you're happy with the code on your computer, you need to commit the changes to Git:

$ git commit -a

This should fire up your editor to write a commit message. When you have finished, save and close to continue.

A well-formatted and descriptive commit message is very helpful to others for understanding why the change was made, so please take the time to write it.

A good commit message looks like this:

Short summary (ideally 50 characters or less)

More detailed description, if necessary. It should be wrapped to
72 characters. Try to be as descriptive as you can. Even if you
think that the commit content is obvious, it may not be obvious
to others. Add any description that is already present in the
relevant issues; it should not be necessary to visit a webpage
to check the history.

The description section can have multiple paragraphs.

Code examples can be embedded by indenting them with 4 spaces:

    class ArticlesController
      def index
        render json: Article.limit(10)
      end
    end

You can also add bullet points:

- make a bullet point by starting a line with either a dash (-)
  or an asterisk (*)

- wrap lines at 72 characters, and indent any additional lines
  with 2 spaces for readability

Please squash your commits into a single commit when appropriate. This simplifies future cherry picks and keeps the git log clean.

5.12 Update Your Branch

It's pretty likely that other changes to main have happened while you were working. Go get them:

$ git checkout main
$ git pull --rebase

Now reapply your patch on top of the latest changes:

$ git checkout my_new_branch
$ git rebase main

No conflicts? Tests still pass? Change still seems reasonable to you? Then move on.

5.13 Fork

Navigate to the Rails GitHub repository and press "Fork" in the upper right hand corner.

Add the new remote to your local repository on your local machine:

$ git remote add fork https://github.com/<your user name>/rails.git

You may have cloned your local repository from rails/rails or you may have cloned from your forked repository. To avoid ambiguity the following git commands assume that you have made a "rails" remote that points to rails/rails.

$ git remote add rails https://github.com/rails/rails.git

Download new commits and branches from the official repository:

$ git fetch rails

Merge the new content:

$ git checkout main
$ git rebase rails/main
$ git checkout my_new_branch
$ git rebase rails/main

Update your fork:

$ git push fork main
$ git push fork my_new_branch

5.14 Issue a Pull Request

Navigate to the Rails repository you just pushed to (e.g. https://github.com/your-user-name/rails) and click on "Pull Requests" seen in the right panel. On the next page, press "New pull request" in the upper right hand corner.

Click on "Edit", if you need to change the branches being compared (it compares "main" by default) and press "Click to create a pull request for this comparison".

Ensure the changesets you introduced are included. Fill in some details about your potential patch including a meaningful title. When finished, press "Send pull request". The Rails core team will be notified about your submission.

5.15 Get some Feedback

Most pull requests will go through a few iterations before they get merged. Different contributors will sometimes have different opinions, and often patches will need to be revised before they can get merged.

Some contributors to Rails have email notifications from GitHub turned on, but others do not. Furthermore, (almost) everyone who works on Rails is a volunteer, and so it may take a few days for you to get your first feedback on a pull request. Don't despair! Sometimes it's quick, sometimes it's slow. Such is the open source life.

If it's been over a week, and you haven't heard anything, you might want to try and nudge things along. You can use the rubyonrails-core mailing list for this. You can also leave another comment on the pull request.

While you're waiting for feedback on your pull request, open up a few other pull requests and give someone else some! I'm sure they'll appreciate it in the same way that you appreciate feedback on your patches.

Note that your pull request may be marked as "Approved" by somebody who does not have access to merge it. Further changes may still be required before members of the core or committer teams accept it. To prevent confusion, when giving feedback on someone else's pull request please avoid marking it as "Approved."

5.16 Iterate as Necessary

It's entirely possible that the feedback you get will suggest changes. Don't get discouraged: the whole point of contributing to an active open source project is to tap into the knowledge of the community. If people are encouraging you to tweak your code, then it's worth making the tweaks and resubmitting. If the feedback is that your code doesn't belong in the core, you might still think about releasing it as a gem.

5.16.1 Squashing Commits

One of the things that we may ask you to do is to "squash your commits", which will combine all of your commits into a single commit. We prefer pull requests that are a single commit. This makes it easier to backport changes to stable branches, squashing makes it easier to revert bad commits, and the git history can be a bit easier to follow. Rails is a large project, and a bunch of extraneous commits can add a lot of noise.

$ git fetch rails
$ git checkout my_new_branch
$ git rebase -i rails/main

< Choose 'squash' for all of your commits except the first one. >
< Edit the commit message to make sense, and describe all your changes. >

$ git push fork my_new_branch --force-with-lease

You should be able to refresh the pull request on GitHub and see that it has been updated.

5.16.2 Updating a Pull Request

Sometimes you will be asked to make some changes to the code you have already committed. This can include amending existing commits. In this case Git will not allow you to push the changes as the pushed branch and local branch do not match. Instead of opening a new pull request, you can force push to your branch on GitHub as described earlier in squashing commits section:

$ git push fork my_new_branch --force-with-lease

This will update the branch and pull request on GitHub with your new code. By force pushing with --force-with-lease, git will more safely update the remote than with a typical -f, which can delete work from the remote that you don't already have.

5.17 Older Versions of Ruby on Rails

If you want to add a fix to older versions of Ruby on Rails, you'll need to set up and switch to your own local tracking branch. Here is an example to switch to the 4-0-stable branch:

$ git branch --track 4-0-stable rails/4-0-stable
$ git checkout 4-0-stable

You may want to put your Git branch name in your shell prompt to make it easier to remember which version of the code you're working with.

Before working on older versions, please check the maintenance policy.

5.17.1 Backporting

Changes that are merged into main are intended for the next major release of Rails. Sometimes, it might be beneficial for your changes to propagate back to the maintenance releases for older stable branches. Generally, security fixes and bug fixes are good candidates for a backport, while new features and patches that introduce a change in behavior will not be accepted. When in doubt, it is best to consult a Rails team member before backporting your changes to avoid wasted effort.

For simple fixes, the easiest way to backport your changes is to extract a diff from your changes in main and apply them to the target branch.

First, make sure your changes are the only difference between your current branch and main:

$ git log main..HEAD

Then extract the diff:

$ git format-patch main --stdout > ~/my_changes.patch

Switch over to the target branch and apply your changes:

$ git checkout -b my_backport_branch 4-2-stable
$ git apply ~/my_changes.patch

This works well for simple changes. However, if your changes are complicated or if the code in main has deviated significantly from your target branch, it might require more work on your part. The difficulty of a backport varies greatly from case to case, and sometimes it is simply not worth the effort.

Once you have resolved all conflicts and made sure all the tests are passing, push your changes and open a separate pull request for your backport. It is also worth noting that older branches might have a different set of build targets than main. When possible, it is best to first test your backport locally against the oldest Ruby version permitted by the target branch's rails.gemspec before submitting your pull request.

And then... think about your next contribution!

6 Contribuintes do Rails

Todas as contribuições recebem crédito em Contribuintes do Rails.

Feedback

Você é incentivado a ajudar a melhorar a qualidade deste guia.

Por favor, contribua se vir qualquer erros, inclusive erros de digitação. Para começar, você pode ler nossa sessão de contribuindo com a documentação.

Você também pode encontrar conteúdo incompleto ou coisas que não estão atualizadas. Por favor, adicione qualquer documentação em falta na main do Rails. Certifique-se de checar o Edge Guides (en-US) primeiro para verificar se o problema já foi resolvido ou não no branch main. Verifique as Diretrizes do Guia Ruby on Rails para estilo e convenções.

Se, por qualquer motivo, você encontrar algo para consertar, mas não conseguir consertá-lo, por favor abra uma issue no nosso Guia.

E por último, mas não menos importante, qualquer tipo de discussão sobre a documentação do Ruby on Rails é muito bem vinda na lista de discussão rubyonrails-docs e nas issues do Guia em português.


dark theme icon