---
# System prepended metadata

title: FE Workflow

---

# FE Workflow
This is a overview of the general FE workflow for how we should be structuring our work. I hope it offers a simple guide to improve efficiency.

## Receiving work
 At the beginning of taking on a new story please: 
 * Assign yourself to the story
 * read the story, and if anything is unclear please ask the creator of the story or refer to design documents on figma or zeplin
 * (suggestion): create an outline of tasks for yourself to accomplish to finish the story. 
     * (bonus): attach these to the story for anyone to take a look at later in case you disappear mysteriously
 * create a new branch for the story starting with 'feat/'
     *  ex: 'feat/story-name'
     * if the story is a fix, you can use 'fix/' instead
 * if building a new component please use the current component structure including
     * index file with exports
     * component file
     * story file
     * test file


## Finishing work
If you are completing a story or are ready for review please
* update snapshots (yarn test -u)
* run tests (fix or remove failing tests)
* remove unneccessary console.logs
* merge with develop
* make sure everything works according to the UI designs and in every edge case

## Creating PRs
after your work is done please create a PR so other developers can review
* create a PR from your branch using syntax (type): (Feature name)
* add information including testing details for developers to double check your work
* link to relevant designs
* squash and merge any changes once its approved (arrow on merge button)
