From 70beb2e40d645178f1917af5ec11ff9fa52185ea Mon Sep 17 00:00:00 2001 From: Erick Friis Date: Wed, 3 Jan 2024 13:19:39 -0800 Subject: [PATCH] docs: contributor faq (#15502) --- docs/docs/contributing/faq.mdx | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/docs/contributing/faq.mdx diff --git a/docs/docs/contributing/faq.mdx b/docs/docs/contributing/faq.mdx new file mode 100644 index 0000000000..e0e81564a4 --- /dev/null +++ b/docs/docs/contributing/faq.mdx @@ -0,0 +1,26 @@ +--- +sidebar_position: 6 +sidebar_label: FAQ +--- +# Frequently Asked Questions + +## Pull Requests (PRs) + +### How do I allow maintainers to edit my PR? + +When you submit a pull request, there may be additional changes +necessary before merging it. Oftentimes, it is more efficient for the +maintainers to make these changes themselves before merging, rather than asking you +to do so in code review. + +By default, most pull requests will have a +`✅ Maintainers are allowed to edit this pull request.` +badge in the right-hand sidebar. + +If you do not see this badge, you may have this setting off for the fork you are +pull-requesting from. See [this Github docs page](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) +for more information. + +Notably, Github doesn't allow this setting to be enabled for forks in **organizations** ([issue](https://github.com/orgs/community/discussions/5634)). +If you are working in an organization, we recommend submitting your PR from a personal +fork in order to enable this setting.