ABAP Code Review Guide is a collection of ideas, tools, and approaches for implementing ABAP code reviews in various landscapes.
The document is provided as open source under the CC license, suggestions and bugfixes are welcome.
Latest PDF release from main can be found at abap-code-review-guide.pdf.
Or you can start browsing the AsciiDoc text online at src/index.adoc (see also editing locally below). Caveat: PlantUML images will just be source code.
The PDF file can be built locally, if Node.js is installed, by running
npm install && npm test
The document is written in AsciiDoc, and can be edited in any text editor. You can start at src/index.adoc.
AsciiDoc lies between Markdown and LaTeX, allowing more markup than Markdown, but less syntax than LaTeX. AsciiDoc provides possibility for inlining diagrams, easy table of contents, plus PDF generation.
vscode with the AsciiDoc extension provides preview directly in the editor.
Each time a commit is pushed (except from forks), GitHub actions will run, build the PDF and attach it to the actions run as an artifact.
When changes is pushed to the default branch, the latest release will be updated with the latest version of the document.