I’m new to contributing to Rails and have been investigating issue #58624, which reports a NameError in the Sign Up and Settings guide.
The guide’s Settings::PasswordsController#update action redirects to settings_profile_path, but the released guide tells the reader to test the password update before that path has been created.
I found that the same underlying problem was previously reported in issue #57471. That issue was closed by PR #57493, which produced this commit:
aea428ac Add step to create path for redirection before launching the application
The commit fixed the problem on main by adding the profile route before the guide tells the reader to test the password update:
namespace :settings do
resource :password, only: [ :show, :update ]
resource :profile, only: [ :show ]
end
However, the commit doesn’t look like it’s been backported to 8-1-stable. The Sign Up and Settings guide exists on 8-1-stable, but it still has the incorrect step, which is why the issue was reported again in #58624.
Based on the Rails contribution guide, my understanding is that the next step would be to open a pullrequest that cherrypicks commit aea428ac to 8-1-stable.
Before doing that, I wanted to confirm that I’m understanding the documentation workflow correctly. Is a backport PR to 8-1-stable the correct approach here, or is there a different process that is us uses for documentation fixes that are already present on main?