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

Add conventions document #1146

Closed
bchrobot opened this issue Apr 12, 2022 · 6 comments
Closed

Add conventions document #1146

bchrobot opened this issue Apr 12, 2022 · 6 comments
Labels
feedback: rfc 🙋 Request For Comment

Comments

@bchrobot
Copy link
Member

bchrobot commented Apr 12, 2022

Is your feature request related to a problem? Please describe.

It is difficult to work on a large codebase with missing or competing conventions.

We have prettier to enforce a single code format and eslint to enforce some style choices/conventions but they do not capture everything.

Describe the solution you'd like

Add a conventions.md document with codebase conventions and style guidelines to capture things that prettier and eslint do not.

Describe alternatives you've considered

Custom eslint rules.

Additional context

Running list of things to include:

  • Component props interface names should be [ComponentName]Props, not just Props.
@bchrobot
Copy link
Member Author

bchrobot commented Sep 8, 2022

@politics-rewired/spoke-rewired thoughts on what else to include in the first draft of this?

@bchrobot
Copy link
Member Author

  • Exporting props type definition for components

@bchrobot
Copy link
Member Author

bchrobot commented Dec 7, 2022

How we handle GraphQL errors under different circumstances.

  • fetching data for display: inline list of errors, using MUI <Alert> component
  • performing an operation from a button -- modal with error? MUI <Snackbar> component?
  • performing an operating from within a modal -- inline errors at top of modal?

@sync-by-unito
Copy link

sync-by-unito bot commented Dec 8, 2022

➤ Benjamin Chrobot commented:

  • Directory structure

@ajohn25
Copy link
Contributor

ajohn25 commented Feb 10, 2023

How we handle GraphQL errors under different circumstances.

  • fetching data for display: inline list of errors, using MUI <Alert> component
  • performing an operation from a button -- modal with error? MUI <Snackbar> component?
  • performing an operating from within a modal -- inline errors at top of modal?

Just mentioning #1270 to link the discussions together

@ajohn25
Copy link
Contributor

ajohn25 commented May 22, 2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feedback: rfc 🙋 Request For Comment
Projects
None yet
Development

No branches or pull requests

3 participants