Skip to content

Add repository structure and numbering standard to README#1

Merged
seesharprun merged 4 commits into
mainfrom
copilot/add-project-plan-to-readme
Mar 18, 2026
Merged

Add repository structure and numbering standard to README#1
seesharprun merged 4 commits into
mainfrom
copilot/add-project-plan-to-readme

Conversation

Copilot AI commented Mar 18, 2026

Copy link
Copy Markdown
Contributor

The repository had a placeholder README with no structure or roadmap. This adds documentation to serve as the source of truth for the repo's organization and sample numbering conventions.

What's added

  • Overview — repo purpose and organization principle (language roots, each project is self-contained)
  • Repository structure — illustrative directory tree showing numbered sample folders under each language root (dotnet/, python/, go/), with query-items examples in the 100–199 range and change feed as the illustrative 200-range example
  • Numbering standard — six numeric ranges mapping to sample categories: 000–099 Connectivity, 100–199 Quickstart, 200–299 Feature usage (change feed, bulk), 300–399 Patterns, 400–499 Advanced (AI/vector search), 500–599 Vertical integration
Original prompt

Let's start implementation by adding the project plan to the README file.

[Chronological Review: The conversation began with the user requesting a review of a user story and a Teams chat to develop a game plan for a draft iteration of a monorepo. The user then defined a numbering standard for samples in the repository, specifying categories and examples. The user later requested to structure the plan for delegation to a cloud agent, followed by a cancellation of that delegation. The user provided a list of sample repositories and requested to plan for future integration while emphasizing the need for a README file. The user also specified that the repository should not have a `/nosql/*` subfolder and expressed a desire for cloud agents to implement a specific table from a comment in a work item. The user sought recommendations for validation processes to ensure code samples are validated correctly across different languages. The user then requested to simplify the project plan, reducing the number of examples per category and ensuring the plan is included in the README for clarity. Finally, the user initiated the implementation by asking to add the project plan to the README file.]

[Intent Mapping:

  1. "Help me come up with a game plan to make a v1/draft iteration of this monorepo."
  2. "Let's define a numbering standard we can use for the samples repository."
  3. "Help me structure this plan so I can delegate each component to a cloud agent."
  4. "On day 1, I really want cloud agents to implement the table from the comment in [work item link]."
  5. "What do you recommend for validation?"
  6. "Yes, update the plan."
  7. "Let's start implementation by adding the project plan to the README file."]

[Technical Inventory:

  • Technologies: Azure Cosmos DB, GitHub, Visual Studio Code
  • Concepts: Monorepo structure, sample numbering standard, cloud agent delegation, validation ruleset, project planning
  • Tools: GitHub for version control, Azure for cloud services]

[Code Archaeology:

  • Files discussed: README.md
  • Changes requested: Add project plan to README, define numbering standard, simplify examples, and include validation strategies.]

[Progress Assessment:

  • Completed: User defined a numbering standard and provided a list of samples.
  • Pending: Implementation of the project plan in the README, validation strategies, and delegation to cloud agents.]

[Context Validation: All necessary context for continuing work on the README and project plan is captured, including user goals for sample organization and validation.]

[Recent Commands Analysis:

  • Last Agent Commands: User requested to "add the project plan to the README file."
  • Tool Results Summary: No specific tool results were returned as the command was a request for action.
  • Pre-Summary State: The agent was preparing to implement the project plan in the README file when the token budget was exceeded.
  • Operation Context: The user aims to establish a clear project plan in the README to facilitate collaboration and understanding for partners and customers.]
1. Conversation Overview: - Primary Objectives: The user aims to create a structured plan for a monorepo of Azure Cosmos DB samples, including a numbering standard, validation strategies, and a clear project plan in the README. - Session Context: The conversation has evolved from initial planning to specific implementation requests, focusing on organization and clarity for future contributions. - User Intent Evolution: The user shifted from broad planning to detailed implementation steps, emphasizing the need for simplicity and clarity in the project structure.
  1. Technical Foundation:
  • Azure Cosmos DB: A cloud database service for building applications.
  • GitHub: Used for version control and collaboration on code samples.
  • Visual Studio Code: The development environment for managing the project.
  1. Codebase Status:
  • README.md:
    • Purpose: To document the project plan and structure for the samples repository.
    • Current State: Awaiting the addition of the project plan as requested by the user.
    • Key Code Segments: Not applicable yet as the implementation is pending.
    • Dependencies: Relies on the overall project structure and sample organization.
  1. Problem Resolution:
  • Issues Encountered: Need for a clear validation strategy to ensure code quality across multiple languages.
  • Solutions Implemented: User has proposed a simplified approach to the project plan and validation.
  • Debugging Context: No ongoing issues reported; focus is on planning and implementation.
  • Lessons Learned: Importance of clarity and simplicity in project documentation.
  1. Progress Tracking:
  • Completed Tasks: User defined a numbering standard and provided a list of sample repositories.
  • Partially Complete Work: Implementation of the project plan in the README is pending.
  • Validated Outcomes: No specific outcomes validated yet; focus is on planning.
  1. Active Work State:
  • Curr...

Created from VS Code.


📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

Co-authored-by: seesharprun <5067401+seesharprun@users.noreply.github.com>
Copilot AI changed the title [WIP] Add project plan to README file Add project plan to README Mar 18, 2026
Copilot AI requested a review from seesharprun March 18, 2026 15:13
Comment thread readme.md Outdated

## Overview

This monorepo contains code samples for Azure Cosmos DB for NoSQL organized by programming language. Each sample is self-contained and demonstrates a specific concept or operation using the Azure Cosmos DB SDK.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just call it a repo, not a monorepo.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in f41cf52.

Comment thread readme.md Outdated

## Overview

This monorepo contains code samples for Azure Cosmos DB for NoSQL organized by programming language. Each sample is self-contained and demonstrates a specific concept or operation using the Azure Cosmos DB SDK.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"SDK for each language."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in f41cf52.

Comment thread readme.md Outdated

## Repository structure

Samples are organized by programming language at the root level. There is no shared `/nosql/` subfolder — each language folder is self-contained.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't mention the subfolder.

Also, the projects are self-contained, not the language folder specifically.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in f41cf52 — removed the subfolder mention and changed "each language folder is self-contained" to "each project is self-contained".

Comment thread readme.md
Comment thread readme.md Outdated
Comment on lines +41 to +54
## Project plan

The table below lists the planned samples for the v1 release. Each sample targets 2–3 examples per category per language.

| # | Name | Category | .NET | Python | Go |
| --- | --- | --- | --- | --- | --- |
| `001` | Connect with passwordless auth | Getting started | ☑️ | | |
| `002` | Connect with connection string | Getting started | | ☑️ | ☑️ |
| `101` | Create an item | Item operations | ☑️ | ☑️ | ☑️ |
| `102` | Read and update an item | Item operations | ☑️ | ☑️ | ☑️ |
| `201` | Query items with a filter | Query operations | ☑️ | ☑️ | ☑️ |
| `202` | Query items with pagination | Query operations | ☑️ | ☑️ | |

> **Legend:** ☑️ = planned for v1

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the project plan entirely. We are going to manage that in GitHub Projects

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed in f41cf52.

Comment thread readme.md Outdated
Comment on lines +56 to +68
## Validation

Each language folder includes a GitHub Actions workflow that builds and validates all samples in that language. Workflows are scoped to path filters so a change in `dotnet/` only triggers the .NET workflow, a change in `python/` only triggers the Python workflow, and so on.

```text
.github/
└── workflows/
├── validate-dotnet.yml # triggered on changes to dotnet/**
├── validate-python.yml # triggered on changes to python/**
└── validate-go.yml # triggered on changes to go/**
```

A GitHub repository ruleset is recommended that requires the relevant language workflow to pass before a pull request can be merged. Because each workflow is scoped to its own path, only the workflow for the affected language needs to pass — keeping CI fast and avoiding unnecessary cross-language failures.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the validation section entirely. The validation agent will add this.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed in f41cf52.

Co-authored-by: seesharprun <5067401+seesharprun@users.noreply.github.com>
Copilot AI changed the title Add project plan to README Add repository structure and numbering standard to README Mar 18, 2026
Copilot AI requested a review from seesharprun March 18, 2026 15:25
Comment thread readme.md Outdated
Comment thread readme.md
…ckstart

Co-authored-by: seesharprun <5067401+seesharprun@users.noreply.github.com>
@seesharprun seesharprun marked this pull request as ready for review March 18, 2026 15:42
@seesharprun seesharprun merged commit c605e8f into main Mar 18, 2026
@seesharprun seesharprun deleted the copilot/add-project-plan-to-readme branch March 18, 2026 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants