Skip to content

Commit 5dfc18d

Browse files
authored
Create coding.rules
1 parent bc60aa3 commit 5dfc18d

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

.patched/coding.rules

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<rules>
2+
<description>Do not add new libraries to package.json.</description>
3+
</rules>
4+
<rules>
5+
<description>Do not use class components; use only functional components.</description>
6+
</rules>
7+
<rules>
8+
<description>Do not leave commented code in the codebase. Informational comments are allowed.</description>
9+
</rules>
10+
<rules>
11+
<description>Do not use Console.log statements.</description>
12+
</rules>
13+
<rules>
14+
<description>Do not use incorrect casing for components, routes, and pages.</description>
15+
<example>
16+
<correct>CatalogueIndex.js</correct>
17+
<wrong>catalogueIndex.js</wrong>
18+
</example>
19+
</rules>
20+
<rules>
21+
<description>Do not use incorrect casing for variables and functions</description>
22+
</rules>
23+
<rules>
24+
<example>
25+
<correct>saveProfileModalIsOpen, openStateSaveProfileModal, isSaveProfileModalOpen</correct>
26+
<wrong>Is-Open, is_open, isOpen</wrong>
27+
</example>
28+
</rules>
29+
<rules>
30+
<description>Do not use state management methods other than useState and Redux.</description>
31+
<example>
32+
<correct>const [isSaveProfileModalOpen, setIsSaveProfileModalOpen] = useState(false); const dispatch = useDispatch(); const Button = useSelector((state) => state.nav.Button); dispatch(setButton(buttons[0]));</correct>
33+
</example>
34+
</rules>
35+
<rules>
36+
<description>Do not use UI libraries other than MaterialUI.</description>
37+
</rules>
38+
<rules>
39+
<description>Do not use the container and item layout model. Instead, use display flex and flex properties within the sx part of a Grid tag.</description>
40+
<example>
41+
<wrong>
42+
&lt;Grid container xs={6} md={12}&gt;&lt;Grid item&gt;
43+
</wrong>
44+
<correct>
45+
&lt;Grid sx={{display: &quot;flex&quot;, flexDirection: &quot;row&quot;, width: isMobile ? &quot;50%&quot; : &quot;100%&quot;}}&gt;&lt;/Grid&gt;
46+
</correct>
47+
</example>
48+
</rules>
49+
<rules>
50+
<description>Do not hard code or push any secret, API key, SSH key, or any sensitive information.</description>
51+
</rules>

0 commit comments

Comments
 (0)