Skip to content

Development Workflow

Paul Le edited this page Aug 31, 2019 · 10 revisions

This repository contains the code that is used in the current Physics in Motion website.

Git Workflow

The development workflow is as follows:

  1. Develop on development/testing environment in a separate branch
  2. Do testing
  3. Commit, merge branch to master, and push to git repository on GitHub
  4. Pull to production environment

Development and testing should be done on a local machine, while production is hosted on an Ubuntu machine.

The master branch is for production, and the development branch is for development.

All commits should have a reference to an issue that is being worked on. When a commit closes an issue, include the appropriate keyword in the commit message.

Each issue should have a label that falls under one of the types of changes defined by keep a changelog. When it comes time to do a release, then major changes will be referenced by their issue number, and the changes will be organized according to what the issue was labeled as.

Coding Best Practices

  1. Use single quotations in JavaScript code, and double quotations in HTML code.
Clone this wiki locally