Coding Guidelines

At dev-team, we program a lot. However everyone has different programming backgrounds, so to make sure we all stay on the same page this page is being created. Here you will find all the things you need to know about how we manage our code.

IDE

Visual Studio Code

We’ll primarily be using VSCode to do all of our code editing in Javascript. VSCode is great because it’s modular and extensible, and it has some pretty cool themes.

Below is a list of all the recommended extensions for this team.

• Bracket Pair Colorizer 2
• ESLint
• GitLens - Git supercharged

Some other cool extensions

• Markdown Preview Enhanced
• Material Icon Theme
• Material Theme
• Ayu (theme)
• TODO Highlight

Fonts

• FiraCode

GitHub

We use GitHub to manage the version of our code. It is essential that everyone is clear on how we use git so that our commit history is clean and legible.

Below are links for essential skills to git.

• Connecting your terminal to git
• Git command cheat sheet
• How to make a proper commit

Pull Requests

Making an effective PR is crucial for the team's understanding of everyone's changes. These descriptions should be meticulous- down the commands that you run. Pretend that the person testing the PR doesn't know how to use a computer.

A PR should follow the template below.

# Feature
A one line description of the feature being made in the PR.
 
# Description
A description of what you had to do to accomplish this feature.
- Were there any hiccups?
- Did you have to deviate from the origin concept of the feature?
- Is this related to any other PRs? (link them here).
 
# Tests
- How did you test your feature?
- What new unit tests did you make?
- What are the steps to reproducing your manual tests?