diff --git a/docs/how-tos/set-up-github-actions.md b/docs/how-tos/set-up-github-actions.md index 41d8147..d6966dc 100644 --- a/docs/how-tos/set-up-github-actions.md +++ b/docs/how-tos/set-up-github-actions.md @@ -7,6 +7,12 @@ It also assumes you have some familiarity with GitHub actions, and have basic QC actions set up. If you are managing an ODK-compliant repo this is certainly the case. +## IMPORTANT - GitHub repo configuration +When using AI agents, ensure that your `main` repository branch has [GitHub branch protection rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) enabled. Specifically, the `main` branch should have at least these settings configured: +- Require pull request reviews before merging +- Require at least one PR reviewer to approve the PR +- Do not allow bypassing the above settings + ## Quick setup with Claude Code If you have [Claude Code](../reference/clients/claude-code.md) installed, you can use the `install-github-app` command for a streamlined setup process. This command will authenticate you and create a pull request with GitHub Actions configuration: