Logo

Running Muse

Muse’s pull-request workflow is the primary way to interact with Muse. Once you have installed Muse on a repository which it can build and analyze (see Getting Started), you are ready to use the pull-request workflow. Muse will automatically analyze your repository each time a pull request is submitted to your repository, comparing the source and destination branches.

After analysis, Muse will report any introduced bugs that it finds as line comments on the GitHub pull-request diff. Any bugs not introduced by the pull-request or falling outside of the diff can be viewed on the Muse Console.

image

Muse will also take advantage of GitHub’s status API to let you know if there were any new bugs introduced by the pull request:

image

The pull-request workflow is the best way to use Muse. It will give you feedback on your code changes without any additional effort. Especially if you are already using a pull-request based workflow, Muse will simply be there like a trusted teammate, always ready to give you a thorough code review. Now that you have the basics down, check out the Configuration Guide to get the most out of Muse.

Having any problems? See our troubleshooting page for a pull-request example to make sure everything is configured properly.