Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Developer Guide for Multi-Repo Dependency and Workflow Management #2

Open
Nicoretti opened this issue Feb 12, 2024 · 0 comments
Labels
documentation User guides, tutorials, specifications

Comments

@Nicoretti
Copy link
Member

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)

@Nicoretti Nicoretti added the documentation User guides, tutorials, specifications label Feb 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation User guides, tutorials, specifications
Projects
None yet
Development

No branches or pull requests

1 participant