Skip to content

Latest commit

 

History

History
130 lines (96 loc) · 5.09 KB

CONTRIBUTING.md

File metadata and controls

130 lines (96 loc) · 5.09 KB
Raw

Contributing

Idea of this file is to provide necessary information for:

  • Setting up development environment
  • How the contribution flow goes

Getting started

This getting started sections helps you setup and start development environment.

Note: Windows users check what the scripts do and then do it manually :)

1 Install required dependencies

2 Install

  1. npm run dev:install
    • Generates .env and .env.test files
    • Installs depencies
    • Applies migrations
    • Seeds database

Note: Runs script located at scripts/dev_install.sh
Note: If you want to use Google sign in see production setup guide

Start and stop project locally

  1. npm run dev
  2. To stop use CTRL + C in terminal

Note: Runs script located at scripts/dev_start.sh
Note: To access database directly see Prisma studio

Contribution flow

New features and fixes

  1. Create an issue for fix or feature
    • Put label task, and assign it to current sprint in backlog
  2. Create new branch from staging branch
    • Naming convention for new branch is #{issue number}/{fix/feat}/{optionally additional information}
    • E.g. #11/fix/duplicate-courses or #45/feat/add-courses
  3. Move task to In Progress in backlog, then do required changes and push the new branch
  4. Create pull request against staging branch
    • Assign someone from project to review it, and wait for approval
  5. After pull request is approved, merge it and delete the merged branch

Note: All changes made to staging are merged to main branch after meeting the client

Reviewing pull request

This helps to identify what to look for when reviewing pull request. Most importantly pull request should be linked to task or set of tasks.

  • Code quality
    • When reading code you should not have to ask yourself what does this do
    • No hard limit for file length, but when it goes over 250 it might be time to split its functionalities
    • Code should be splitted to appropriate folders
      • app: should not contain much logic, only usage of folders components and lib
      • components: any UI components required by app
      • lib: utilities, third party libs, etc.
  • TypeScript
    • Should not use any type unless it has good reason
  • Form validation
    • Form validation should use Zod library
    • Schema is only defined once and its used in frontend and backend (api folder)
  • UI
    • The styling should follow same format as other parts of site
    • No hardcoded colors, use theme
    • UI should be responsive
    • Errors should be handled, and the user informed of them (without sensitive data)
  • Tests
    • Feature has meaningful tests which cover edgecases
  • Documentation
    • Code itself should be documented (or refactored) if you have to ask yourself what does this do
    • If changes to code affect anything in docs folder, they should be updated
  • Security
    • Should trainer or user be able to access this, if not is it prevented?
    • No sensitive information in git or logs
  • Performance
    • Middleground between poorly optimized code and complex algorithms is usually good enough
  • Translation keys

Branching

There are two main branches main and staging. Main branch is for production. Staging branch is mostly for developers to test new features in very similar environment as production without the fear of breaking important things. Here is simple diagram to show branching flow:

graph TD;
    A[New feature or fix branch] -->|Merge| B[Staging Branch];
    B -->|Merge| C[Main Branch];
    C -->|Deploy| D[Production];
    B -->|Deploy| E[Staging];
Loading

Good to know

Prisma

Prisma studio is tool that can be used to visualize and add records to database. Use npx prisma studio to run it.

Migrations in development
With schema migration
  1. Run npx prisma migrate dev, and follow the instructions
  2. Push the generated migration to git
With schema and data migration

You can also refer to Prisma customizing migrations

  1. Run npx prisma migrate dev --create-only, and follow the instructions.
  2. Edit the generated migration
    • For example model user had image column which is moved to model user_information as profile_image column. In this case you would have to modify the migration.sql to insert image column data to profile_image column for correct user id.
  3. Run npx prisma migrate dev to apply the changes and verify that the data migration worked
  4. Push the generated migration to git

Course reminders

Course reminders are scheduled with GitHub Actions workflow. For more details see documentation.