You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by ot...@apache.org on 2020/05/07 16:50:49 UTC
[plc4x] branch feature/c-api updated: add CODE_CONVENTIONS
This is an automated email from the ASF dual-hosted git repository.
otto pushed a commit to branch feature/c-api
in repository https://gitbox.apache.org/repos/asf/plc4x.git
The following commit(s) were added to refs/heads/feature/c-api by this push:
new 2d8a6ca add CODE_CONVENTIONS
new 7d0f92d Merge pull request #151 from ottobackwards/c-api-m7
2d8a6ca is described below
commit 2d8a6caf184d950540528dbfbad76c63c54879c0
Author: Otto Fowler <ot...@gmail.com>
AuthorDate: Thu May 7 12:49:54 2020 -0400
add CODE_CONVENTIONS
---
sandbox/plc4c/CODE_CONVENTIONS.md | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/sandbox/plc4c/CODE_CONVENTIONS.md b/sandbox/plc4c/CODE_CONVENTIONS.md
new file mode 100644
index 0000000..8ee3c63
--- /dev/null
+++ b/sandbox/plc4c/CODE_CONVENTIONS.md
@@ -0,0 +1,9 @@
+# Apache PLC4C Code Conventions
+
+This is not a style guide, but rather a set of conventions to be used when creating variable, functions, and structs from an implementation point of view.
+It is also concerned with naming conventions and other patterns to maintain a consistent, maintainable codebase.
+
+## Naming
+
+- Functions that free/clear/delete resources shall have destroy as part of the naming
+-