Add GitHub Copilot support files (.github/copilot-instructions.md, .github/copilot-setup.yml) #2764
Conversation
…thub/copilot-setup.yml) Signed-off-by: Arshdeep728281 <[email protected]>
|
|
||
|
|
||
|
|
||
| # Project Structure — CycloneDX cdxgen |
There was a problem hiding this comment.
Can we make this tree simpler by only listing the source code?
| - It is built to integrate into CI/CD pipelines and large scale security workflows. | ||
|
|
||
| ### Core Capabilities | ||
| - Generate SBOMs (Software Bill of Materials) for many project types and languages. :contentReference[oaicite:4]{index=4} |
There was a problem hiding this comment.
No just SBOMs but multiple other BOM documents as well.
| ### Core Capabilities | ||
| - Generate SBOMs (Software Bill of Materials) for many project types and languages. :contentReference[oaicite:4]{index=4} | ||
| - Support for container image analysis, and even live systems / VMs in some cases. :contentReference[oaicite:5]{index=5} | ||
| - Output formats include JSON, XML and other formats per the CycloneDX specification versions 1.4–1.6. :contentReference[oaicite:6]{index=6} |
| - For container/image security, extract BOMs from images and VMs to feed into risk assessment workflows. | ||
|
|
||
| ### Technology & Ecosystem | ||
| - Written in Node.js / TypeScript. |
There was a problem hiding this comment.
JavaScript and not TypeScript. cdxgen-plugins-bin is not an architecture, but merely a library to support certain languages and binary types.
|
|
||
| ## 🧪 Testing Configuration | ||
| test: | ||
| framework: Jest |
| --- | ||
|
|
||
| ## 🧩 Notes for Copilot | ||
| notes: |
There was a problem hiding this comment.
This section needs more information related to testing requirements, coding conventions, and where to place the code.
| - bom.json | ||
| - bom.cdx | ||
| - bom.json.map | ||
| - logs/cdxgen-debug.log |
There was a problem hiding this comment.
logs and signature are not always created. .map is only created for java when run with --deep argument.
|
Great start! Do you have any screenshots showing Copilot using these instructions to suggest some fixes and features? |
2 participants
Replaces #2686 with a clean, conflict-free branch.
This PR adds Copilot configuration and documentation files under .github/
to improve GitHub Copilot and Copilot Chat context understanding for contributors.
No changes made to README or workflows.
@malice00 @prabhu – ready for review.