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

Tweniee/Isssue:#11361 Updated Document for PR #11509

Closed
wants to merge 2 commits into from
Closed

Tweniee/Isssue:#11361 Updated Document for PR #11509

wants to merge 2 commits into from

Conversation

Tweniee
Copy link
Contributor

@Tweniee Tweniee commented Nov 8, 2023

Summary

Added rebase functionality to the documentation.

References

Issue:#11361

Reviewer guidance

Its a documentation change only in .rst file.


Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

Copy link
Member

@MisRob MisRob left a comment

Choose a reason for hiding this comment

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

Hi @Tweniee, thanks for volunteering!

There's one important change that needs to be resolved. We don't really want to update "Submitting a pull request" section of "Getting started" page with this information. To submit a pull request, rebase is not necessary and having this guidance there would be confusing. We only recommend it in some cases. That's why in #11361 it is suggested that this guidance is added as a completely new page in "How To Guides", alongside other tutorials:

Screenshot from 2023-11-08 13-24-42

Please move it there and leave "Getting started" as is. As soon as it's done, we will review wording in more detail. Let me know if you have any questions.

@Tweniee
Copy link
Contributor Author

Tweniee commented Nov 8, 2023

@MisRob okay it seems fine, let me do respective changes then.
thanks

@Tweniee Tweniee closed this Nov 9, 2023
@Tweniee
Copy link
Contributor Author

Tweniee commented Nov 9, 2023

Closing this, i'll be creating new fresh PR for the same

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

Successfully merging this pull request may close these issues.

2 participants