github / github/docs

`restrict-creations` should warn about compatibility with merge queues

Open Beginner friendly
#45,334 2 comments 0 reactions 0 assignees View on GitHub
content needs SME repositories
Dominant language
TypeScript
Stars
20.8k
Forks
68.7k
Avg merge
12h 24m
Merged PRs (30d)
105

Description

### Code of Conduct

- [x] I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/.github/CODE_OF_CONDUCT.md)

### What article on docs.github.com is affected?

https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#restrict-creations

### What part(s) of the article would you like to see updated?

[Restrict creations](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#restrict-creations)

Explain that you need to add the `GitHub Merge Queue` app to the bypass list if you apply the rule to "all branches" (or anything that would match the github merge queue branch pattern)

- https://github.com/community/community/discussions/167530

### Additional information

The github merge-queue prefix appears to be documented as `gh-readonly-queue/{base_branch}`:

https://github.com/github/docs/blob/68352680faac5483ecbe6472c5a20c5d81bb2ec0/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md?plain=1#L49

Contributor guide

Open the contributing guide

Research direction

Start with the Restrict creations section in the affected available-rules-for-rulesets article, then read the linked merge queue article and community discussion for context. Done means the section clearly explains the required GitHub Merge Queue bypass when the rule matches merge queue branches, with the relevant branch pattern documented accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.