From 55c8ea497f5fef8e0dc3505a090aa0d9e7bf2895 Mon Sep 17 00:00:00 2001 From: Paul Pacheco Date: Sat, 19 Jan 2019 09:07:12 -0600 Subject: [PATCH] Document coding convention --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aec754903..2db179bfb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -117,6 +117,9 @@ Start reading our code and you'll get the hang of it. We optimize for readabilit \`NetworkIdentity identity\`, not \`NetworkIdentity uv\` or similar. If the variable needs a comment the name needs to be changed. For example, `msg = ... // the message` use `message = ...` without a comment instead * **type vs. var**: Please use 'int x' instead of 'var x', etc. in all cases. Here is why: whenever +* **private** + Fields and methods in a class are private by default, no need to use the private keyword there. + Note fields and methods are public by default in structs so it might be necessary there. * This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible. **One Python Way**