gracel0 / standards-and-practices

Standards and Practices for Shift3

Standards and Practices

Reason for Repo

• Set and maintain standards for Shift3/Bitwise projects.
• Have a central repository where other Shift3/Bitwise members can share knowledge of best practices.
• Have a reference point to start a new project or answer questions on different topics.

Click Here to contribute!

Code of Conduct

1. No cussing, we're beyond that
2. Keep the requests and issues professional and relevant to the work we're doing at Shift3/Bitwise
3. Treat others with the same respect you would if you were talking to them in person. Don't be a jerk.
4. Have fun and share your knowledge!

New to Shift3?

Here's what we expect you to know before you write any code:

• Please read all the links included

Git

• Gitflow
  • Keep branches for master and development
  • Branch off of development for features
  • Request reviews on your Pull Requests
  • Merge reviewed code into development
• Branching at Shift3
• Commit Messages at Shift3

Code Versioning

• Shift3 SemVer

Project Setup

• Using Github Projects to communicate progress
• Readme Guidelines to document projects

Code Review

• Code Review process at Shift3
  • Code Review Slides
• Acceptance Testing
• Bug Reporting

Machine Setup

Mac: Install:

• Homebrew
• nvm
• Slack
  • Sign into shift3tech.slack.com team with your work email
• Either WebStorm(See below before you install) or Visual Studio Code

Windows:

• (Optional) Install a third-party antivirus product of your choice.
• Activate Windows using a valid license key. If you don't already have one, ask HR about getting one.
• Install all available Microsoft updates, restarting your computer as necessary.
• Open PowerShell with Administrator privileges. Run Set-ExecutionPolicy RemoteSigned. Type Y and press Enter to confirm that you want to make this change. (If you don't perform this step, you will not be able to run any PowerShell scripts on your system.)
• Install the Chocolatey package manager for Windows.
• Reopen PowerShell with Administrator privileges, if necessary. Run the install-apps-via-chocolatey.ps1 script to install a number of programs you will probably need. (Feel free to peek at this file's contents to see what it contains.)
• (Optional) From the same PowerShell window, run the command oosu10. Here, you can easily configure a number of settings to have Windows respect your privacy a little more. Just make sure you understand what each setting does before you change it.
• After running oosu10, restart Windows (if applicable).
• Install Android Studio.
• Install the regular version of Visual Studio (as opposed to Visual Studio Code). Visual Studio Community Edition may be sufficient, or you may need a paid license for Visual Studio Professional, Enterprise, or similar. Either way, ask your PM (Project Manager).
• You may wish to use the Windows Subsystem for Linux.
• Ask your Project Manager if you need to install anything else.

Using Chocolatey has several advantages:

1. You can install most of the software you need just by running a single script.
2. You can update all of this software later, by running choco upgrade all, as Administrator.
3. Chocolatey will automatically skip installing browser toolbars and junk like that.

Account Setup

You will need to schedule time with Greg Goforth, Corey Schuman, Chris Hawkins, or Jody Hicks to gain access to the following:

AWS Account:

• AWS is our primary platform for deployment (staging and production) so you should familiarize yourself with their JavaScript SDK and whitepapers.

Shift3 Standards & Practices Meetings:

Meetings are now split into two types:

• Presentations: Once a month the developers meet on Wednesday from 4:00pm - 5:00pm to discuss a new Standard or Practice for the company. A developer at Shift3 will propose a new tool or standard to be adopted, and there will be an open forum to discuss. You are highly encouraged to participate actively by leading a meeting on a topic of your choice. Ask Ryeker Herndon to add you to the GCal event so that you get reminders and emails.
• Workshops: Once a month we will do a deep dive into a topic of interest for our workflow and/or processes. These will typically take longer than 1 hour, and will be a classroom/workshop setting. One developer will lead the workshop and the goal will be to produce developers who are proficient at a skill or process that will help us in our work.

Frontend Masters:

• Shift3's main online teaching tool is Frontend Masters. They have courses on all of the platforms we employ at Shift3, and you should take advantage of as many as possible.

WebStorm:

• If you prefer to use JetBrains' tooling, Shift3 provides us with WebStorm Suite for free. We also use Visual Studio and Visual Studio Code.

Photoshop:

• If your job entails design work, you will need to get access to the Shift3 Adobe Photoshop license.

Contributing to Shift3

You are expected to contribute something to our processes. You can do this in many different ways, such as leading a S&P meeting, writing up a markdown sheet for this repository on a topic you are passionate about, leading a workshop, or posting discussion topics in Bitwise's #shift-3-technical-discussions channel.

Click Here to start contributing.