Skip to content

Dev conventions

Mats Tyldum edited this page Dec 9, 2020 · 27 revisions

Naming

  • Folder naming: Lower camelCase, e.g. notFound
  • Components folder and components naming: Upper CamelCase, e.g. NotFoundScreen

Workflow

  • Always update Trello board and push changes to your branch regularly when you are working so others can follow your work.
  • All PR's goes directly to the main branch.
  • Merging is done by the author of the PR
  • Branch naming: kebab-case
  • Two types of branches:
    • Feature: All additions and improvements to the code base, except critical bug fixes. Naming: feature/feature-description
    • Bug: Critical bug fixes only, naming bug/bug-description

Styling

  • Common styles defined in theme folder. Example of usage see MapScreen.
  • Create stylesheets in same file as component
  • Avoid inline styling
  • Icons: TBD

File structure

├── assets
│   ├── fonts
│   ├── images
├── components
│   ├── ExampleComponent.tsx
├── screens
│   ├── auth
│   │   ├── LoginScreen.tsx
│   │   ├── SignUpScreen.tsx
│   ├── notFound
│   │   ├── NotFoundScreen.tsx
│   ├── exampleScreen1
│   │   ├── ExampleScreen1.tsx
│   ├── exampleScreen2
│   │   ├── ExampleScreen2.tsx
├── theme
│   ├── ThemeProvider.tsx
├── navigation
│   ├── Index.tsx
│   ├── BottomTabNavigator.tsx
└── App.tsx (entry point)
Clone this wiki locally