Skip to content

Commit

Permalink
add contribution guidelines (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
peebeejay authored Aug 25, 2021
1 parent f236bca commit 754d292
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ Run the following commands:
3) `sudo apt install npm`
4) `sudo npm install -g yarn`

### Contribution Guidelines
To streamline contributions to React code within the Wagyu codebase, a small set of guidelines encapsulating our opinions is included here:
1) Libraries - Use `styled-components` for css encapsulation, `rem` units for any pixel sizes (potentially via the utility library `polished`).
2) Typescript - Make generous use of everything typescript has to offer (don't use `any`... ever).
3) Formatting - This codebase uses `prettier` (rules defined in `.prettierrc`) for standardized code formatting. If using vscode, the formatter will run on save, if not, be sure to run `npx prettier --write "**/*.ts*"` to format the code.
4) Common components - Extract commonly used typography or UI elements into the `typography` directory.
5) Utility Functions - Keep utility functions that don't deal with rendering outside of components.
6) Other Opinions - Refrain from using 'render' functions within functional components. Extract this logic out into a separate component instead. Refrain from using `<br />` and use padding and/or margin instead.


## Support
Reach out to the EthStaker community:
- on [discord](https://invite.gg/ethstaker)
Expand Down

0 comments on commit 754d292

Please sign in to comment.