Skip to content

Commit f3a8371

Browse files
committed
Make explicit that we care about interfaces
This provides a broad guideline what an interface is and how to maintain it.
1 parent 0dae046 commit f3a8371

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CODING_STANDARD.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
Here a few minimalistic coding rules for the CPROVER source tree.
22

3+
# Interfaces
4+
- With any changes, consider the impact on other users of the code base. Users
5+
frequently carry their own set of patches or build tools on top of the code
6+
base. Large-scale changes negatively impact both scenarios.
7+
- Tools that link against the code base can reasonably expect a stable
8+
interface. We consider as public interface any objects, procedures, or classes
9+
(and their methods) that are meant to be used outside a single directory.
10+
- See below for how to document interfaces and how to mark parts of interfaces
11+
as deprecated.
12+
313
# Whitespaces
414

515
Formatting is enforced using clang-format. For more information about this, see

0 commit comments

Comments
 (0)