Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Contributing] Add documentation for rebasing when contributing to the docs #19949

Open
wants to merge 3 commits into
base: 5.4
Choose a base branch
from

Conversation

AndoniLarz
Copy link

@AndoniLarz AndoniLarz commented Jun 7, 2024

Title pretty much says it all : I asked on Slack about how to rebase my docs branch because I'm not used to rebasing.

We noticed there is no such documentation on the Contributing to the Documentation page, whereas there is one in the Proposing a Change.

So here is the PR to add such a section.

QUESTIONS :

  • Maybe the Rebase your branch title is too big ?

@carsonbot carsonbot added this to the 5.4 milestone Jun 7, 2024
@@ -136,9 +136,38 @@ even remove any content and do your best to comply with the

**Step 6.** **Push** the changes to your forked repository:

Rebase your branch
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding a heading here breaks the steps.

the case of rebasing should be a section later in the doc, not in the quick start guide for your first contribution (and maybe it could link to the documentation about rebasing a PR for code contribution instead of duplicating it, as it works exactly the same, given that this is purely about git usage)

Copy link
Author

@AndoniLarz AndoniLarz Jun 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with the idea of just using a link and made a commit accordingly.
However, I believe the link would be useful here so that beginners don't feel lost if they face this case. Be it because they began working days or weeks ago, or just minutes ago and by chance a PR got merged just in the meantime.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants