Basic Configuration
After installing the Rulesets GitHub App, create a configuration file in your repository:.github/Ruleset.yml
in your repository.
How It Works
This basic rule:- Triggers when PRs are opened or edited
- Validates that PR titles are at least 10 characters long
- Ensures PR descriptions are not empty
- Adds a “valid-pr” label when validations pass
- Comments with guidance when validations fail
The
{{ validation_summary }}
template variable will be replaced with details about which validations passed or failed.Common Configurations
Here are some common use cases to help you get started:Conventional Commits
Enforce Conventional Commits format for PR titles:PR Size Limits
Limit the size of PRs to keep them manageable:Auto-Assign Reviewers
Automatically assign reviewers to new PRs:Branch Naming Convention
Enforce branch naming standards:Next Steps
- Explore Rules to understand the structure in depth
- Check out Validators to learn about different validation types
- See Actions for all available actions you can take
- Browse Examples for more advanced configurations