You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iceberg.apache.org by bl...@apache.org on 2021/12/23 19:58:29 UTC

[iceberg] branch master updated: Docs: Added config naming (#3800)

This is an automated email from the ASF dual-hosted git repository.

blue pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iceberg.git


The following commit(s) were added to refs/heads/master by this push:
     new 1bbefa1  Docs: Added config naming (#3800)
1bbefa1 is described below

commit 1bbefa1c06e0a193d078f5204f95b7bd16755640
Author: sanyu daver <57...@users.noreply.github.com>
AuthorDate: Fri Dec 24 01:28:15 2021 +0530

    Docs: Added config naming (#3800)
    
    Closes #3678
---
 CONTRIBUTING.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 88f215e..aa1a77b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -122,3 +122,10 @@ When passing boolean arguments to existing or external methods, use inline comme
   dropTable(identifier, true /* purge data */);
   dropTable(identifier, purge);
 ```
+
+#### Config naming
+
+1. Use `-` to link words in one concept
+    * For example, preferred convection `access-key-id` rather than `access.key.id`
+2. Use `.` to create a hierarchy of config groups
+    * For example, `s3` in `s3.access-key-id`, `s3.secret-access-key`