programming_formalisms_project_2023

Branch [1]	check_package	measure_coverage	check_links	check_spelling
master
develop
acorbat
bea
carolina
daniel
EcoRedWine
michael
richel
romanos
sarah
thomas
renate

• [1] Branches are ordered: master, develop, then name of the feature branches alphabetically

The project of the UPPMAX 'Programming Formalisms' course in 2023.

We develop together here, passcode 42.

Goal

• Develop code together in a formal/structured way
• Get experience with best practices
• Maybe bonus: use the code developed for your own work

Workflow

• Always work in a project, create a Project if needed. The first Issue for a Project is to document what it needs to do.

• Within a project, always work on one Issue: assign yourself and move to 'In Progress' on the kanban board

• Each problem start with a design that is reviewed: when an Issue is posted for review, move the Issue to 'Under review'

• Each reviewed design is implemented using TDD, after which the code is reviewed: when an Issue is posted for review, move the Issue to 'Under review'

• Always work in pairs. Switch roles using either time, or Ping-Pong technique

• Branching model from Vincent Driessen's post (see also this video: YouTube download (.ogv))

  • master always works
  • develop is where merging takes place. Merging to develop is done by a Pull Request with a code review, that follows a Code of Conduct
  • Feature branches are where Issues are fixed

• Use of TDD

• Use of CI: tests, codecov, ruff

• 100% code coverage

• ruff style guide

Newbie Issues

1. Join the team
2. Create a branch with your name
3. Add your personal branch to README.md
4. Pick and solve an early Euler problem:
   • 1
   • 2
   • 3
   • 4
   • 5
   • 6
   • 7
   • 8
   • 9
   • 10

In all cases:

• Assign yourself to the Issue if you work on it: only then it is yours
• Put the Issue to 'In Progress' while you work on it
• Put the Issue to 'In review' after doing the Pull Request to develop

Junior Issues

Here you are more free.

Pick your favorite among:

• Refactor a solved Euler project solution
• Improve the speed of a solved Euler project solution
• Solve a harder Euler project problem
• Solve a custom problem: create a simple design document first

In all cases:

• Create an Issue for it

Feedback to students

• Feedback to students

Guidelines

• Agile software development
• Design by Contract
• The C++ Core Guidelines (i.e. those that apply to code in general)
• C++ Coding Standards: 101 Rules, Guidelines, and Best Practices (see Table of Contents)
• Classes follow Design Patterns
• Don't Repeat Yourself
• Rules of Thumb, Laws, Guidelines and Principles
• SOLID principles (for OOP)
• Principle of Least Astonishment: POLA
• You aren't gonna need it: YAGNI
• Fail Fast
• Refactoring

Files

Links

• Project Euler