StrictDoc Documentation
Developer Guide
DEVGUIDE_GETTING_STARTED

1. Getting started

DEVGUIDE_GETTING_STARTED

1.1. System dependencies

1.1.1. Windows-specific: Long Path support

1.2. Installing StrictDoc from GitHub (developer mode)

1.2.1. Development within a virtual environment

2. Invoke for development tasks

3. Main "Check" task

4. Linting

4.1. Black for Python code formatting

DEVGUIDE_PYTHON_CODE

5. Python code

DEVGUIDE_PYTHON_CODE

5.1. Python version

5.2. Line length

5.3. Strong type system

5.4. Order and naming of functions

5.5. Full descriptive names

5.6. Short-lived/temporary variables

5.7. Explicit If-checks

5.8. Opening files

DEVGUIDE_GIT_WORKFLOW

6. Git workflow

DEVGUIDE_GIT_WORKFLOW

7. Frontend development

8. Testing

8.1. Running integration tests

8.2. Running End-to-End Web tests

9. Documentation

10. Conventions

11. Playbooks

11.1. Software development

11.2. How to update release notes