How to interact with Propel
A quick user guide for how to interact with Propel within Github. Covers how to trigger a review, adding to knowledge base, auto-naming, and reactions.
Triggering a review or re-review
Note: Reviews will happen automatically on PR creation
This command allows you to re-trigger a review from Propel
/propel review
Knowledge Base
Teach Propel your team’s guardrails so reviews stay consistent. When a rule is added, Propel enforces it on every future pull request across your connected repositories.
Example company rules
| Rule name (Auto-Generated) | Rule |
|---|---|
| Variable preferences | Prefer creating new variables with descriptive names over mutating existing variables. |
| Use Typography | Use the shared Typography component instead of custom font size handling. |
| CompanyID casing | Use CompanyId consistently instead of CompanyID across services. |
There are 4 main ways to add to your knowledge base:
1. Tell Propel directly in the pull request (remember to use /propel)
/propel add to knowledge base "{insert company rule here}"
2. Add a rule in the knowledge base page
You're also able to configure rule settings in this page.
3. Add rules to .propel/rules and we will automatically pick up the rules in review
Propel will reference the files at .propel/rules in every review regarding that specific repo.
4. Add a specific file from your repo to the knowledge base page
If you would like to reference a different markdown file or have rules applied across different repos, you can do so at the knowledge base page
PR Auto-Naming
Name your PR's @auto - Propel will rename the PR based on the code changes
Name your PR's {ticket_number} @auto - Propel will rename and include ticket number in title
Reactions
A quick 👍 or 👎 helps us tune Propel to your company's needs
