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

Different defaults with and without protection #18935

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

alexgenaud
Copy link

@alexgenaud alexgenaud commented Jul 5, 2022

Out of the box, (git push --force) is allowed "by default". With branch protection, it's not allowed "by default". These distinctions are not obvious because of two "default" contexts.

I struggle to explain that here and in text, but I think it's important to note, somehow. It certainly confused me.

Perhaps better would be a table of default values.
Columns to include: "default git", "default github", "default branch protection", "default [other contexts]";
and rows including all the different settings such as "enforce_admins", "allows_force_pushes", "allows_deletions", etc.

Why:

Why? I was confused by what "default" means. We configure our hundreds of repositories via Terraform. It seemed to me there was no point in setting "default" values to their "default" state. However, it was not clear to me that "default" has a different meaning based on context (with or without branch protection).

Closes [18936] "Explain different default contexts (fx with and without branch protection)"
#18936

What's being changed (if available, include any code snippets, screenshots, or gifs):

I offer an short paragraph, although I expect a side note box; or a table of settings, defaults, overrides; or rewording of extant paragraphs are likely better changes.

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

Out of the box, (git push --force) is allowed "by default". With branch protection, it's not allowed "by default". These distinctions is not obvious because of two "default" contexts.

I struggle to explain that in text, but I think it's important to note, somehow. It certainly confused me.
@welcome
Copy link

@welcome welcome bot commented Jul 5, 2022

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage label Jul 5, 2022
@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Jul 5, 2022

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md fpt
ghec
ghes@ 3.5 3.4 3.3 3.2 3.1
ghae
fpt
ghec
ghes@ 3.5 3.4 3.3 3.2 3.1
ghae

@cmwilson21 cmwilson21 linked an issue Jul 5, 2022 that may be closed by this pull request
1 task
@cmwilson21
Copy link
Collaborator

@cmwilson21 cmwilson21 commented Jul 5, 2022

@alexgenaud Thanks so much for opening a PR! I'll get this triaged for review

@cmwilson21 cmwilson21 added content waiting for review repositories and removed triage labels Jul 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content repositories waiting for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants