Welcome to Software Engineering for Datasetu

This document is meant as a guide for all developers of the Datasetu/ARTPARK team. It lists out best practices for:

• Designing systems

• Writing code

• Using version control systems

• Release cycles

• Planning and writing tests

• Bugfixes, patches and updates

It also lays out a formal process for development. This is by no means an exhaustive document. Au contraire, it is only meant to serve as a guide to avoid the most common pitfalls. Following the guide to the letter also does not ensure flawless design and bug free code.

Table of Contents

• Effectively using git
  • General git dos and don’ts
  • Understanding the git pull-request workflow
    • The need for a workflow
    • The Pull-Request Workflow - Demystified
  • Some good practices for the workflow
  • When not to use this workflow
  • Best practices for large projects
  • Troubleshooting guide
    • Merge conflict hell
    • X commits ahead and Y commits behind
  • Quick Checklist
• Clean Code
  • General guidelines
  • Security
    • General guidelines for security