damus.io

commit 08aeec6783e65f3bd2fd6fbdf875be10b585ec7d
parent 1a1a38ddf282d60588083b83736d7292a2c59ec0
Author: Thomas Mathews <thomas.c.mathews@gmail.com>
Date:   Sat, 12 Nov 2022 12:51:38 -0800

web: Updated contribution guide.

Diffstat:
M
web/README.md
 | 
32
+++++++++++++++++---------------

1 file changed, 17 insertions(+), 15 deletions(-)
diff --git a/web/README.md b/web/README.md
@@ -1,4 +1,4 @@
-# Damus PWA 
+# Damus Web 
 
 Here lies the code for the Damus web app, a client for the Nostr protocol. The
 goal of this client is to be a better version of Twitter, but not to reproduce
@@ -9,22 +9,24 @@ all of it's functionality.
 There are rules to contributing to this client. Please ensure you read them 
 before making changes and supplying patch notes.
 
-1. No transpilers. All source code should work out of the box.
-2. Keep source code organised. Refer to the folder structure. If you have a
+ - No transpilers. All source code should work out of the box.
+ - Keep source code organised. Refer to the folder structure. If you have a
    question, ask it.
-3. Do not include your personal tools in the source code. Use your own scripts
-   outside of the project. This does not include build tools such as Make.
-4. We use a non-standard js style: tabs and snake_case for variables and functions. Sorry.
-5. Do not include binary files.
-6. No NPM (and kin) environments. If you need a file from an external resource
+ - Do not include your personal tools in the source code. Use your own scripts
+ - outside of the project. This does not include build tools such as Make.
+ - Use tabs.
+ - Write methods in snake_case.
+ - Do not include binary files.
+ - No NPM (and kin) environments. If you need a file from an external resource
    mark the location in the "sources" file and add it to the repo.
-7. Do not write code using experimental browser APIs.
-8. Do not write animations in JavaScript, CSS only. Keep them short and snappy.
+ - No frameworks. Learn the browser tools and write good code. 
+ - No experimental browser APIs.
+ - Do not write animations in JavaScript, CSS only. Keep them short and snappy.
    Animations should not be a forefront, but an enjoyable addition.
-9. All new & modified code should be properly documented.
-10. Source code should be readable in the browser.
+ - All new & modified code should be properly documented.
+ - Source code should be readable in the browser.
 
-TODO Write about code style requirements & add number of spaces.
+These rules are subject to discussion.
 
 ## Style Guide
 
@@ -32,6 +34,6 @@ TODO Write about the style guide.
 
 ## Terminology
 
- * Sign Out - Not log out, logout, log off, etc.
- * Sign In  - Not Login, Log In, etc.
+ * Sign Out - Not "log out", "logout", "log off", etc.
+ * Sign In  - Not "login", "log in", "signin", "sign-in", etc.