README.md

Development in PAF

First steps

If this is your first time working with the project you can follow the first steps in /doc/development/first_steps.md.

Development guidelines

If you contribute to this project please read the following guidelines first:

1. Documentation Requirements
2. Linting
3. Git Style
4. Reviewing
5. Project management
6. Github actions
   1. linting action
   2. build action
   3. drive action
7. Install python packages
8. Discord Webhook Documentation

Templates

Templates for documentation and code are provided in doc/development/templates. These templates are to be used for new files that are added to the project.

template_class.py

Use this class if you don't have much experience with python. If you just want to copy an empty class use template_class_no_comments.py.

template_class_no_comments.py

If you just want to copy an empty class use this class.

template_wiki_page.md

This template functions a template for who to build knowledge articles for everyone to understand. The basic structure should be kept for all articles. This template is empty and can be used straight forward.

Discord Webhook

Discord Webhook Documentation