---
# System prepended metadata

title: Contributing

---

# Contributing

- [ ] Support German and English language in frontend

## Type of tests

- Unit tests
- Acceptance tests
- Integration tests

## Styleguide

ToDo

## Issues

### Content 
- User Story well documented (user-centered)
    - `As a ... I want ... in order to ...`
    - Who?, What?, Why?
- Dependencies are specified
    - Other Tickets
    - UI/UX design
    - Architectual design
- Acceptance Criteria are specified (See Definition of Ready)
- Required resources estimated
    - Worktime
    - Knowledge (specialized workforces)
    - External workforce
    - Compute power / hardware
- Priority / Importance given (reevaluate regularly)
- Impact given (reevaluate regularly)


## Commit messages
```
#<issue number> short commit message

detailed description of changes
```

## Branch names

Each branch name should match the following RegEx:
`^(?=.{1,50}$)(feature|fix|refactor)\/(?<issue>#[0-9]+)(?<descriptor>(-[a-z0-9]+){1,3})$`

So the branch name should begin with one of the types `feature`, `fix`, `refactor` followed by a slash `/` and the number of the related issue (preceded by a `#`). After that follows a description of one to three words separated by a dash `-`. The whole branch name must not be longer than 50 characters.

An example of an allowed branch would be `feature/#42-author-model`.