Skip to content

fix: add pull request writing rules #13

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.

Sign up for GitHub

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

Merged
bnymn merged 1 commit into from
Jun 21, 2026
Merged

fix: add pull request writing rules #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 5 additions & 36 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Codex Plugin Marketplace

This repository is a custom Codex plugin marketplace for the
`engineering-playbook` plugin. The marketplace lets Codex discover the plugin
so it can be installed from the plugin browser.

## Install

Add the marketplace to Codex:
Expand All @@ -20,39 +16,12 @@ Open the plugin browser:

Select the marketplace, install `engineering-playbook`, and start a new Codex thread.

## Repository policy

Changes to `main` should go through pull requests. The repository policy is:

- only squash merges are enabled;
- squash merge commit titles default to the pull request title;
- merge commits and rebase merges are disabled;
- `main` requires a pull request before merging;
- `main` requires the `Conventional PR title` check to pass;
- `main` requires one approving review from `@bnymn` as code owner;
- administrators are included in the branch protection rule;
- force pushes and branch deletion are blocked.

This is a public repository, so external contributors can open pull requests from
forks. They cannot push to protected branches or merge pull requests unless they
are added as collaborators with sufficient repository permission.

The pull request workflow validates the PR title against the same commit title
convention used for releases:

```bash
npm run validate-pr-title -- "feat: add release automation"
```
## Update

Apply or re-apply the GitHub repository settings with:
Open the plugin browser:

```bash
npm run apply-repository-policy
```text
/plugins
```

The GitHub token used by `gh` must have repository Administration write access to
update branch protection. To preview the API payloads without changing GitHub:

```bash
npm run apply-repository-policy -- --dry-run
```
Update `engineering-playbook`, then start a new Codex thread.
6 changes: 5 additions & 1 deletion plugins/engineering-playbook/skills/development/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,12 @@ Create a pull request only when all of these are true:
- unresolved `Low` findings have been shown to the user
- Mago passes without warnings or errors
- relevant tests pass
- the commit message and pull request title use Conventional Commits
- the pull request description is one short high-level plain-English paragraph
without technical details
- the pull request description includes `Closes #<issue-number>` when the work
resolves a GitHub issue
resolves a GitHub issue, and does not mention any issue the pull request does
not resolve

If any gate is not clean, do not create the pull request. Report what is done,
what failed, the commands run, and the question or decision needed from the
Expand Down