Files
concrete/docs/dev/conventions.md
2021-12-27 09:55:57 +01:00

18 lines
519 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Developer conventions
## Code
% Coding style, Tests, comments style
The LLVM formatting is used for the C++ code.
[LLVM FileCheck](https://www.llvm.org/docs/CommandGuide/FileCheck.html) is used for tests on dialects (lowering, roundtripping).
[GoogleTest](https://google.github.io/googletest/) is used for other tests.
Documentation comments use three slashes, ///, instead of two.
Place documentation comments just before the item theyre documenting.
## Github
% Branch naming, issues, commit message, PR