libraries, tools, samples, and resources maintained in a single README.md file. This is a documentation-only repository with no build processes or code compilation.
Always reference these instructions first
3.2k3y agoReviewMountCreate a free account to mount
version requirements in upstream docs
- Consider bundling related updates together (e.g., Erlang + RabbitMQ + ejabberd)
- Document upgrade warnings in `CHANGELOG` when migrations are needed
### Adding Architecture Support
When the limit
3.2k33d agoReviewMountCreate a free account to mount
Subsurface AI Coding Agent Guidelines
Welcome to the Subsurface codebase! This document provides essential guidelines for AI coding agents to be productive and effective contributors to this project. Subsurface
3.2k20mo agoReviewMountCreate a free account to mount
organized in numbered folders (`01-IntroductionToGenerativeAI/` through `05-ResponsibleAI/`), each with a `readme.md` for documentation.
- All code samples live in the centralized `samples/` directory, organized by category: `CoreSamples/`, `MAF/`, `AppsWithGenAI
3.2k8mo agoReviewMountCreate a free account to mount
specific rules in
`.github/instructions/` for the changed files: C++ sources and tests
(`source-code`), documentation (`documentation`), KOKKOS (`kokkos`), unit tests
(`force-style-tests`), example inputs (`regression-tests`), and the build
3.1k15d agoReviewMountCreate a free account to mount
platform behavior, feature gates, wire compatibility, and failure semantics.
## Before changing code
- Read the documentation for the affected subsystem. Start with the references below rather than inferring behavior from names
Steady5 mentions in 2 weeks
No other project uses it yet
3.1k11d agoReviewMountCreate a free account to mount
handlers, or special cases for one input.
- Input validation is appropriate at a documented boundary. It is not a substitute for fixing an internal invariant that valid input breaks
3.1k7mo agoReviewMountCreate a free account to mount
reference repos, and ensure you have the necessary tools installed. The remainder of this document assumes you have done this.
### Customizing the Shared Context Repository
The shared-context repository
3.1k4mo agoReviewMountCreate a free account to mount
will fail due to configuration issues
## Common Tasks
### Repository Structure
```
/home/runner/work/kubespy/kubespy/
├── README.md # Main project documentation
├── CONTRIBUTING.md # Development guidelines
├── Makefile # Build automation
├── go.mod # Go module definition
├── kubespy.go # Main entry point
3.1k20d agoReviewMountCreate a free account to mount
comments over what comments. For complex logic, include references to related files or documentation. Do not remove existing comments unless they are clearly outdated or incorrect.
## Integration Points
- **GitHub Copilot
3.1k21mo agoReviewMountCreate a free account to mount
Review priorities
- Determine the intended behavior from the PR description, changed code, tests, and documentation; comment only when the implementation does not safely establish that behavior.
- Prioritize defects with
No other project uses it yet
3.1k3mo agoReviewMountCreate a free account to mount
Follow the project style**: Ensure all changes adhere to the existing code and documentation style. Review the [project's codebase](/) to understand the conventions used.
2. **Use Material Design color
Steady13 mentions in 2 weeks
No other project uses it yet
3k22mo agoReviewMountCreate a free account to mount
making changes. It is the canonical guide
for architecture, safety, implementation, validation, and documentation expectations.
Do not duplicate repository guidance here. If instructions need to change, update `AGENTS.md
3k3mo agoReviewMountCreate a free account to mount
SONiC (Software for Open Networking in the Cloud) repository — the central hub for project documentation, architecture designs, High Level Design (HLD) documents, roadmaps, governance, and community information. It serves
No other project uses it yet
3k9mo agoReviewMountCreate a free account to mount
test/ # Gadget-specific tests
README.md # Short description with link to full docs
README.mdx # Full documentation in MDX format for the website
```
- `gadget.yaml` defines datasources with field annotations (`columns.width`, `columns.hidden`, `columns.alignment
No other project uses it yet
3k13d agoReviewMountCreate a free account to mount
directory.
- The core library code is located in the `core/` directory.
- The documentation files are located in the `docs/` directory.
- The constants files are located in the `constants/` directory
No other project uses it yet
2.9k3mo agoReviewMountCreate a free account to mount
linker, bgen)
- `tests/` - Test suites (unit, introspection, extrospection)
- `msbuild/` - MSBuild tasks and targets
- `docs/` - Documentation and guides
- `runtime/` - Runtime components and native code
## Build System
This project uses a Make
No other project uses it yet
2.9k5mo agoReviewMountCreate a free account to mount