Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Coding Style Guide #74

Open
PaulieScanlon opened this issue Sep 9, 2020 · 1 comment
Open

Coding Style Guide #74

PaulieScanlon opened this issue Sep 9, 2020 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@PaulieScanlon
Copy link
Owner

PaulieScanlon commented Sep 9, 2020

We have in the repo eslint and prettier which gets us some of the way to ensuring code consistency but there are a number of other areas where a coding style guide would be helpful for contributors. Some things that spring to mind are as follows:

  • Uses FunctionComponent
  • Uses Pure functions
  • Doesn't use Classes
  • Exports are named / not default
  • utils fare sometimes co-located and larger more comment utils are in the general utils dir

I imagine there's a tool out there that can help format this but if anyone stumbles across this issues and would like to help i'd be happy to collaborate.

@PaulieScanlon PaulieScanlon added enhancement New feature or request hacktoberfest Open source is changing the world - one pull request at a time labels Sep 9, 2020
@PaulieScanlon PaulieScanlon self-assigned this Sep 9, 2020
@matiasfha
Copy link
Contributor

I think eslint rules can help you with first 4 items there..

@PaulieScanlon PaulieScanlon removed the hacktoberfest Open source is changing the world - one pull request at a time label Oct 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants