Developer Guide

This guide provides all the necessary information for contributing to the project. It covers core concepts, design principles, and instructions for setting up your development environment. You will also find detailed procedures for testing, creating releases, and other common development tasks.

Concepts

• Overview
• Design
  • High-level build workflow
  • Principles
  • Project design structure
  • Commandline design patterns
  • Configuration design patterns
  • Documentation design patterns
• Project Overview
  • Directory Structure
  • File Structure

Tasks

• Project Dependencies
  • Operating System
  • Python
  • Editor
  • External tools
• Preparing Your Development Environment
  • High-level project overview
  • Helper Tools
  • GitHub CLI
  • Setting up the development environment
  • Getting Docserv’s Config Files
• Installing Visual Studio Code Editor
• Developing the Project
  • Listing dependencies
  • Using IPython
• Create Pull Requests
• Running the Test Suite
  • Running the full test suite
  • Running specific tests
  • Running failed tests only
  • Interpreting coverage
• Updating a Specific Package
• Bumping the Version
• Updating the Project
• Adding News Fragments
• Building the Changelog
• Creating a New Release
• Triggering Actions Manually
• Building Documentation
• Howto
  • Adding or removing a new product
  • Changing the language set
  • Changing the lifecycle set
  • Changing the app’s config paths
  • Changing the app’s config file names

Appendix

• Knowing GitHub Project Setup
  • GitHub Actions
  • Rulesets