Workflow

This project follows the forking workflow. For contributing to this project, fork this repository under your GitHub account and submit a pull request when features are ready for merging back to the upstream (this repository).

The master branch is treated as the development branch that contains newly added features, which can be deployed on the development server for testing. When working on new features, follow the feature-branch workflow to create a feature branch and merge it back to the master branch when finished. During merging, squash the commits on the feature branch to a single commit that clearly describes the feature. One exception is changing the readme file, which can be committed with message "Update README.md" directly to the master branch without a feature branch. Another exception is hotfixes for bugs or critical usability issues, which can be directly committed to the master branch.

Resources:

• Git commands for managing branches
• Git commands related to the workflow
• GitHub Guides: Forking Projects
• GitHub Guides: Understanding the GitHub Flow