Skip to main content

Workspace Setup

Overview​

Developing modern JavaScript applications requires efficient, powerful, and extensible tooling. Consistency across developer machines is a priority when collaborating across highly distributed teams. The following is a guide for installing the preferred environment for JS development.

workspace setup

Secure Groups​

Visit secure.uhc.com to request permissions groups:

  • github_users: To access github.com
  • Mac_Admin: To install software for macOS users only

VSCode Editor​

To write code for UI projects, it is highly recommended that you download and install Visual Studio Code.

Visual Studio Code

VSCode Extensions​

Recommended extensions will be suggested to you when you visit the VSCode Marketplace.

  • ESLint - code syntax validator

ESLint is a JavaScript linting tool which is used for automatically detecting incorrect patterns found in ECMAScript/JavaScript code. It is used with the purpose of improving code quality, making code more consistent, and avoiding bugs. Rules can be configured to look for all kinds of discrepancies due to discouraged code patterns or formatting. Running a Linting tool over the source code helps to improve the quality and readability of the code.

Prettier is very popular because it improves code readability and makes the coding style consistent for teams. Developers are more likely to adopt a standard rather than writing their own code style from scratch, so tools like Prettier will make your code look good without you ever having to dabble in the formatting.

System Essentials​

Xcode​

xcode-select contains necessary utilities for software development on macOS. Xcode's simulator will be used for viewing your app in an iOS environment.

xcode-select --install

After install, exit and restart Terminal (CMD + Q)

$ xcode-select --version

Android Studio​

Install Android Studio. The Virtual Device Manager will be use for viewing your app in an Android environment.

Additional Tools​

zsh is an optional upgrade to the native shell which provides a delightful terminal experience.

sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)"

After install, exit and restart Terminal (CMD + Q)

omz version

nvm is a great tool for installing and upgrading versions of Node on your system.

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.1/install.sh | bash

After install, exit and restart Terminal (CMD + Q)

nvm --version


nvm install 16 && nvm use 16 && nvm alias default 16

After install, exit and restart Terminal (CMD + Q)

$ npm --version


$ npm config set registry https://repo1.uhc.com/artifactory/api/npm/npm-virtual

git is a universal version control system for working collaboratively and efficiently.

git config --global user.id "YOUR_MS_ID"


git config --global user.email "YOUR_EMAIL@optum.com"

Git Branch Names​

Naming the branch you're working on helps repository maintainers understand the changes being made when the PR is opened. Using consistent branch name prefixes also allows build tools to automatically categorize the branches using labels. Branch names should be all lowercase (with the exception of US and DE) and include hyphens between words. All branches are divided into four groups:

  • story/####### - Changes associated with a User Story, use the unique 7-digit number from Rally followed by a task description.

  • defect/####### - Changes associated with a Defect, use the unique 7-digit number from Rally followed by a task description.

  • refactor/ - Changes to the repo that aren't documented in Rally are considered refactors, so use the task portion to add detail to your branch name.

  • release/ - Used specifically by build tools, this branch name is exclusive to release notes and documentation leading up to a new release.

Examples:

git checkout -b story/US2434515-developer-toolkit


git checkout -b defect/DE308703-button-accessibility


git checkout -b refactor/select-list-multi-docs


git checkout -b story/US1533842-use-loading-overlay

Branch Name Rules:

  • Branch prefix must start with story, defect, refactor, or release
  • Branch name must be only lowercase letters, numbers, and hyphens
  • US### and DE### are valid character exceptions
Table of Contents