Preset Configs
OctoGuide provides two starting preset “configs”, or lists of rules:
- recommended (default): Rules that apply to almost every open source GitHub repository
- strict: Everything in recommended, plus enforcing semantic pull request conventions
See Configuration > config for how to specify a config in your GitHub Actions workflow.
Rules Table
Section titled “Rules Table”Config key:
- ✅
- Recommended
- 🔒
- Strict
| Area | OctoGuide Rule | Entity Description | Config |
|---|---|---|---|
| Comments | comment-meaningless | should be meaningful, not just '+1'-style bumps | ✅ |
| PRs | pr-branch-non-default | should be sent from a non-default branch | ✅ |
| PRs | pr-body-not-empty | should have a description beyond the template | ✅ |
| PRs | pr-linked-issue | should be linked as closing an issue | 🔒 |
| PRs | pr-task-completion | tasks from the template should be [x] filled out | ✅ |
| PRs | pr-title-conventional | titles should be in conventional commit format | 🔒 |
| Text | text-image-alt-text | images should have descriptive alt text | ✅ |