Skip to main content
Use the knowledge base to teach Propel your team standards. When you add a rule, Propel applies it to future reviews across connected repositories.

​
Example company rules

Rule nameRule
Variable preferencesPrefer creating new variables with descriptive names over mutating existing variables.
Use TypographyUse the shared Typography component instead of custom font size handling.
CompanyId casingUse CompanyId consistently instead of CompanyID across services.

​
Add rules in four ways

​
1. Add rules directly in a pull request

Use /propel add to knowledge base in a pull request comment: 
/propel add to knowledge base "<your team rule>"
Screenshot showing a rule added to the knowledge base from a pull request comment.

​
2. Add rules in the knowledge base UI

Open the knowledge base page in the app and create or edit rules there: https://app.propelcode.ai/knowledge-base Screenshot of the Propel knowledge base page. Screenshot of rule configuration on the Propel knowledge base page.

​
3. Add rules in .propel/rules

Store repo-specific guidance in .propel/rules. Propel reads these files during review for that repository. Screenshot of a .propel/rules file in a repository.

​
4. Add markdown files as rule sources

You can attach additional markdown files in the knowledge base UI to apply rules across multiple repositories. Screenshot of adding a markdown file as a knowledge base rule source. Screenshot of configuring how a rule source is applied in review.

​
Next steps

  1. Add one rule from a recent pull request.
  2. Re-run /propel review on an active pull request.
  3. Confirm the rule is applied in Propel comments.