Development

Description

This will describe some front end technical docs to help our developers make maintainable, composable , and more simple code.

Project Management Tools

Design

See the Design Wiki

Task Manager

We are using Pivotal Tracker as our management

Messaging

We are using Slack to communicate

Git

I highly suggest this reading this: Introducing Git Flow
Here's a YouTube video with a helpful video Git Flow Explain
Linus Torvalds may know a thing or two about good commit messages A Good Commit Message
For more information on tagging read this: Tutorial for Tagging

Linting

We are using eslint to style and check for potential issues such as accessibility.

To check the errors and warnings run: npm run lint:check

To auto fix problems run: npm run lint:fix

Note that some warnings / errors cannot be resolved with this command.

Testing

Testing of new React components is provided via Jest

npm run test npm test npm t

Additionally, we use Enzyme

Storybook

For every feature, there should be a storybook for each components so that you can develop the UI fast enough and also, the other developers can play around the UI components easily. Please check it out this website for more details of the tool.

To get it started, please do the following:

• Delete node_module folder, package-lock.json and yarn.lock to remove the old version that's currently installed to your local system and avoid errors when running the storybook command
• Re-install the dependencies again via npm run install or yarn install
• Run storybook: npm run storybook or yarn storybook
• You can access the storybook in this url: http://localhost:9009/
• Here's a great tutorial how to create a storybook https://www.learnstorybook.com/intro-to-storybook/react/en/get-started/