Pārlūkot izejas kodu

Added docs on where to place custom hooks

jnfrati 4 gadi atpakaļ
vecāks
revīzija
325fa1b0c4
1 mainītis faili ar 19 papildinājumiem un 5 dzēšanām
  1. 19 5
      docs/developing/frontend-guide.md

+ 19 - 5
docs/developing/frontend-guide.md

@@ -1,14 +1,17 @@
 # Porter Frontend Contribution Guide
 
-### Components 
+### Components
 
 #### Functional Components and Migration
+
 Currently, most of the frontend is written using Class Components. If you contribute to any part of the frontend, you are encouraged to rewrite any class component into a functional component. While doing so, keep a few things in mind:
 
 #### Context
+
 If a prop is passed down more than three levels in the component heirarchy, it should be rewritten to be contained in a context. Make sure that all the components that then consume this context are functional, since the Context API isn't very good for class components.
 
 #### Typing and Internal Organization
+
 To keep a functional component consistent, it should be typed using `React.FC` with a `Props` interface. Internally, the hooks used by the component should be listed near each other at the start of the function body, to avoid confusion. For example, the following is a component that obeys these rules:
 
 ```typescript
@@ -20,14 +23,13 @@ const MyComponent: React.FC<Props> = (props) => {
     const [foo, updateFoo] = useState(...);
     const [bar, updateBar] = useState(...);
     const { baz } = useContext(...);
-    
+
     const qux  = ...;
-    
+
     ...
 }
 ```
 
-
 ### Routing model for new standard:
 
 The idea is to keep something similar to what NextJS or Angular+2 with submodules does, if we have a route the folder structure should try to respect that path
@@ -66,4 +68,16 @@ We should end with the following structure
 ```
 
 All first level routes should have it's own folder as it may be considered a new module of the application, inside each module we may have specific components we don't wanna share between modules, those should be named with an underscore first to be clear that they're not pages but simple components.
-In the case that the Routes.tsx on the module became too long, it can be divided into subroutes inside the subfollowing folders.
+In the case that the Routes.tsx on the module became too long, it can be divided into subroutes inside the subfollowing folders.
+
+### Hooks
+
+One of the advantages of using react 16+ is the posibility to create custom hooks, so if you feel that something could be easier or you could reduce the repetition of logic by using custom hooks we encourage you to do so!
+
+#### Where should I place my new hooks
+
+If the hook that you're creating may be used all over the application you can add it to the `src/shared/hooks` folder, if not, you can place them right next to the components that will be using the hooks.
+
+#### Typing and documentation
+
+Please note that every hook that you may create will be used by other people, so typing it and adding comments on how it works/why you create such hook is super useful and we encourage this behaviour.