The StyleCI Docs

Welcome to the StyleCI docs. You'll find comprehensive guides and documentation to help you start working with StyleCI as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Guides


Save time with automation.

StyleCI provides deep integration with GitHub's status API, meaning that we can provide reports on pull requests.

Now, you have 2 awesome options to choose from at this point:

1. Let us do everything for you

Now, if the contributor's code is failing our checks, this is actually totally fine, because, after merging the PR, we can send you a pull request to fix the code. How awesome is that! By default, we won't send this PR without asking, but you can simply toggle this in your settings, to get us to automatically send a PR without you asking, and we have another setting that can even get us to automatically merged the PR too!

Manual triggering of automatic fix PRs can be done from the analysis page:

Automatic sending/merging of these fix PRs can be enabled from the settings page:

2. You'd like more control

If you'd prefer to make sure everything's just right before merge, or you prefer to commit your own fixes, that's super easy too. On every analysis page, we provide a diff download link where you can download a diff that can be applied using git apply. This can be useful if you'd like the contributor to fix the CS issues, or useful if you'd like to merge their PR using Gush, and fix the issues as you merge. So powerful!

You can even use GitHub's protected branches feature to prevent bad changes getting merged.

What's Next



Save time with automation.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.