This user guide, like Cake.Prca itself, is under very active development. Some parts of it aren't documented as completely as they need to be, but we gladly accept your contributions.
We need your help to improve the documentation for Cake.Prca, so if there is something that you would like to add then you can edit the content directly on GitHub.
Overview
Overview about features and requirements of the Pull Request Code Analysis Addin.
| Features | Overview about core features. |
| Requirements | Requirements for using Cake.Prca. |
| Release Notes |
Fundamentals
Basic concepts of the Pull Request Code Analysis Addin.
| Architecture | Architecture overview. |
| Issue Provider | Overview about issue providers. |
| Pull Request System | Overview about pull request system implementations. |
Usage
How to obtain, configure, and execute Cake.Prca.
| Basic usage | Basic usage instructions. |
| Tutorials | Tutorials how to use the Cake Pull Request Code Analysis Addin with different build and pull request systems. |
Issue Provider
Documentation of the different issue provider addins.
| DocFx | Issue provider which allows you to write any warnings logged by DocFx as comments to a pull request. |
| ESLint | Issue provider which allows you to write any issues logged by ESLint as comments to a pull request. |
| InspectCode | Issue provider which allows you to write any issues logged by JetBrains Inspect Code as comments to a pull request. |
| markdownlint | Issue provider which allows you to write any issues logged by markdownlint as comments to a pull request. |
| MsBuild | Issue provider which allows you to write any warnings logged by MsBuild as comments to a pull request. |
Pull Request System
Documentation of the different pull request system implementations.
| TFS & VSTS | Support for Team Foundation Server and Visual Studio Team Services. |
Extending
Instructions how to add support for additional analyzers and pull request system to the Pull Request Code Analysis Addin.
| Issue Provider | Instructions how to add support for additional analyzers to the Pull Request Code Analysis Addin. |
| Pull Request System | Instructions how to add support for additional pull request system to the Pull Request Code Analysis Addin. |