Add repository structure and numbering standard to README#1
Merged
Conversation
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
seesharprun
requested changes
Mar 18, 2026
|
|
||
| ## 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. |
Collaborator
There was a problem hiding this comment.
Just call it a repo, not a monorepo.
|
|
||
| ## 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. |
Collaborator
There was a problem hiding this comment.
"SDK for each language."
|
|
||
| ## Repository structure | ||
|
|
||
| Samples are organized by programming language at the root level. There is no shared `/nosql/` subfolder — each language folder is self-contained. |
Collaborator
There was a problem hiding this comment.
Don't mention the subfolder.
Also, the projects are self-contained, not the language folder specifically.
Contributor
Author
There was a problem hiding this comment.
Updated in f41cf52 — removed the subfolder mention and changed "each language folder is self-contained" to "each project is self-contained".
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 |
Collaborator
There was a problem hiding this comment.
Remove the project plan entirely. We are going to manage that in GitHub Projects
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. |
Collaborator
There was a problem hiding this comment.
Remove the validation section entirely. The validation agent will add this.
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
seesharprun
requested changes
Mar 18, 2026
…ckstart Co-authored-by: seesharprun <5067401+seesharprun@users.noreply.github.com>
seesharprun
approved these changes
Mar 18, 2026
7 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
dotnet/,python/,go/), with query-items examples in the100–199range and change feed as the illustrative200-range example000–099Connectivity,100–199Quickstart,200–299Feature usage (change feed, bulk),300–399Patterns,400–499Advanced (AI/vector search),500–599Vertical integrationOriginal 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:
[Technical Inventory:
[Code Archaeology:
[Progress Assessment:
[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:
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.- 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.
- 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.
- 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.
- 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.
- 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.