Process Guide

[HettieM]

Overview

This issue is intended to document for our current processes within this project.
This issue must not be edited without the full agreement of all members of the team.

Priorities

What do we want to achieve in this project?

• Semantic HTML
• Forms appropriately labelled
• Site accessible by keyboard navigation
• Avoid divs
• Use aria labels
• Use TDD
• Implementing Jest testing FE & BE (J)
• Setting up a CI workflow (J)

Stand-ups

Stand ups will be held at 5:30 for 15 minutes.

• What you have done
• What you plan to do next + what else your task needs working on
• Blockers
  Please review the kanban daily and check it is up to date.

Workflow

• Issues to be added by scrum master
• Issues will be fleshed out by those working on them, processes defined step-by-step with checkboxes
• Remember to link issues to kanban board
• P0 bugs (with red label) for issues that need to be resolved immediately - can be added by anyone
• Assign yourself to issues that you are working on
• Be sure to review code before merging pull request (ask for walkthrough if you don't understand)

Pre-pull-request Checklist

• Master branch up to date and merged into current branch
• Lint + prettier used
• Tests passing
• No console.log

Naming Branches

Follow convention (issue number)-feature/fix-branch-name
e.g. 13-feature-add-search-function AND 20-fix-change-searchbar-colour

Commit messages

• Include issue #
• Write imperative tone (describe what the commit does, not what it did)
• Write with correct grammar
• Remember to co-author

Modules

• Installed modules should be described on the project readme

React Component File Structure

• Include subfolders for

• Customers
• Vendors
• Shared

• Each component should have individual JS, test and style files

Styled Components

Please follow the style guide for global css variables

Constants Folder

• Use constants folder to hold ALL routes for an easy update at later dates.