exasol/pytest-plugins

Create Developer Guide for Multi-Repo Dependency and Workflow Management

Opened this issue · 0 comments

Summary

Create documentation that guides developers on "How-to" use and work with this (multi repo) repository.
It should address workflow(s) within a single project, as well as working and managing "inter"-dependencies between the projects.

This guide should also highlight common pitfalls and what to watch out for when working within this multi-repo environment.

Possible Structure

  1. Multi-Repo Structure: Provide an overview of the multi-repository architecture, including the purpose of each repository and how they interlink.

  2. Dependency Management: Document the process for managing dependencies across repositories, including:

    • How to identify and manage internal dependencies.
    • Tools and scripts used to automate dependency updates.
    • Versioning strategies for internal dependencies.
  3. Workflow Process:

    • Steps for the development process within the multi-repo setup
    • How to handle cross-project changes or features that span multiple projects.
  4. Common Pitfalls and Watchouts

  5. Tools and Integrations: Overview of tools, scripts, and CI/CD integrations that support the multi-repo workflow. Guidance on how to use these tools effectively.

  6. Point of contact(s): People which can be contacted in case of doubt (@tkilias, @Nicoretti)