Skip to content

Commit 588aaa6

Browse files
authored
Update Style Guide.md
1 parent 8afa15e commit 588aaa6

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

Style Guide.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
# MadaData Code Style Guide
22

3-
## Frontend
3+
## Naming
4+
5+
*It is very important to figure out names and make naming exact and consistent*
46

5-
* [Airbnb Javascript Style Guide](https://github.com/airbnb/javascript)
6-
* [Airbnb React/JSX Style Guide](https://github.com/airbnb/javascript/tree/master/react)
7+
- use `logIn`, `logOut`, and `signUp`, and their snake_case accordingly.
8+
- do no use `login` unless it is used as a name (but prefer `credential` or `principle`)
9+
- do not use `signin` or `signout` or other variations
10+
- use camelCase for acronyms, like `UserDao` and `graphQlSchema`, not `UserDAO` or `graphQLSchema`
11+
12+
## Frontend
713

14+
- [Airbnb Javascript Style Guide](https://github.com/airbnb/javascript)
15+
- [Airbnb React/JSX Style Guide](https://github.com/airbnb/javascript/tree/master/react)
816

917
## Java
1018

1119
Use IntelliJ and http://github.com/Madadata/java-code-styles
1220

13-
## General Rules
21+
## Other General Rules
1422

15-
* [CS106A](https://web.stanford.edu/class/cs106a/styleguide.shtml)
23+
- [CS106A](https://web.stanford.edu/class/cs106a/styleguide.shtml)

0 commit comments

Comments
 (0)