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

Document styling with bootstrap and styled components #77

Open
jensren opened this issue Feb 27, 2022 · 1 comment
Open

Document styling with bootstrap and styled components #77

jensren opened this issue Feb 27, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jensren
Copy link
Collaborator

jensren commented Feb 27, 2022

What: Add a new Wiki page for styling guidelines, and refer to the styling Wiki page in the README wiki page.

Why: we want developers with little css experience to look at the documentation and style their code following our guidelines.

How:

  • Add a new page to the Wiki for styling
  • Refer to the styling Wiki page in the README, so new devs know to look there
  • Add any additional default styles needed for us to use default styles out of the box

Information to include:

  • How to use a default bootstrap style (as in your PR)
  • How to use a default styled components style (as in your PR)
  • When we should use bootstrap vs. styled components
    • Mention that in general, we should not style bootstrap styles with styled components, because bootstrap components are supposed to look the same as each other. We should only style bootstrap components if we need the bootstrap component to do something significantly different (e.g. making a vertical navbar from bootstrap's horizontal navbar)
    • Mention that we should only use styled components if no bootstrap component is available
  • Include that we don't need the app to look exactly the same as the Figma designs. It's ok if it looks slightly different (or even significantly different), as long as it matches the theme and looks good
  • Link the Figma page with the default styles
  • Include guidelines on where to put styles in the code (e.g. put styled component styling under the component)
  • Include guidelines on what naming conventions we are using (e.g. style component for NavBar component will be called StyledNavBar)
  • Include guidelines on how to import bootstrap components (e.g. I saw you had it as import Button from 'react-bootstrap/Button' and not import { Button } from 'react-bootstrap')
@jensren jensren added the documentation Improvements or additions to documentation label Feb 27, 2022
@pratikmdhr
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants