From d1f4d01ac82746efbad5fef7b70fbfe28709f872 Mon Sep 17 00:00:00 2001 From: Luiz Carvalho Date: Fri, 22 Sep 2023 12:07:18 -0400 Subject: [PATCH] Add blurb about bypassing rulesets Signed-off-by: Luiz Carvalho --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 7024667..cc29010 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,10 @@ ruleset](https://docs.github.com/en/repositories/configuring-branches-and-merges at the organization level. This is not done automatically. When adding a new workflow, be sure to also update the corresponding ruleset [here](https://github.com/organizations/enterprise-contract/settings/rules). + +An existing ruleset may prevent direct pushes to the default branch, e.g. `main`, for a variety of +reasons. Although pushing a commit directly to `main` is not recommended, certain occasions require +it. For example, it is not possible to create a pull request targeting a brand-new empty repository. +In such cases, add a temporary exception target for the corresponding ruleset. Remember to revert +this change. Alternatively, avoid creating empty repositories altogether by always choosing to +include a license.