Skip to content

Latest commit

 

History

History
69 lines (41 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

69 lines (41 loc) · 2.57 KB

Contribution guidelines

Content


General

First of all, thank you very much for participating in this project.

Here are a few important points that you should look at / read through before you start.

Coding guidelines

This project follows the following coding guidelines / conventions: Common C# code conventions

Principles

The following principles should/must be observed:

  1. DRY (Don't repeat yourself) - Click here for more information
  2. YAGNI (You aren't gonna need it) - Click here for more information
  3. KISS (Keep it simple, stupid) - Click here for more information
  4. SOLID - Click here for more information

New stuff

If you add something, make sure that a corresponding function / class / etc. does not yet exist.

Architecture

This project uses a simple, horizontal layered multitir architecture.

If you are not familiar with it, please read the following: Multitier architecture (Wikipedia).

This architecture must not be broken. If this is still the case, please contact us beforehand.

WPF & MVVM

This project uses WPF with MVVM and the UI framework MahApps. If you are not familiar with this, please read the following:

The NuGet package CommunityToolkit.MVVM is used for the use of MVVM. You can find out more about this here: MVVM Toolkit

Branch

Every change must be made in a branch. Changes in the Main branch are not permitted!

Summary

Once you have familiarized yourself with everything, you can get started.

Have fun developing and if you have any questions, don't hesitate to ask (you can use the Discussions)