Skip to content

Remove QUALITY_IMPROVEMENTS.md, add NuGet badge, and add comprehensive SECURITY.md#97

Merged
Malcolmnixon merged 5 commits intomainfrom
copilot/remove-quality-improvements-file
Dec 15, 2025
Merged

Remove QUALITY_IMPROVEMENTS.md, add NuGet badge, and add comprehensive SECURITY.md#97
Malcolmnixon merged 5 commits intomainfrom
copilot/remove-quality-improvements-file

Conversation

Copy link
Contributor

Copilot AI commented Dec 15, 2025

Plan for Repository Documentation Updates

  • Remove QUALITY_IMPROVEMENTS.md file (as changes are captured in autogenerated release notes)
  • Add NuGet shield badge to README.md for the DemaConsulting.SpdxTool package
  • Create SECURITY.md file with:
    • Statement that only the latest version is supported
    • Instructions to use GitHub vulnerability report feature
  • Verify all changes are correct
  • Run build and tests to ensure no issues (all 97 tests pass, 0 warnings)
  • Address code review feedback (fixed table formatting in SECURITY.md)
  • Address PR comments:
    • Moved NuGet badge to last position and made it clickable link to nuget.org
    • Expanded SECURITY.md with additional standard sections (What to Expect, Security Update Process, Security Best Practices, Input Validation, Security Tools Used, Responsible Disclosure, Security Hall of Fame, Contact, Additional Resources)
  • Fix cspell issue by adding 'sandboxed' to .cspell.json dictionary
Original prompt

Remove the QUALITY_IMPROVEMENTS.md file, as changes such as this are captured in the autogenerated release notes.

Please add a nuget shield for the DemaConsulting.SpdxTool package.

Please add a standard SECURITY.md file indicating that only the latest version is supported and that the Github vulnerability report feature should be used.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits December 15, 2025 18:31
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Remove QUALITY_IMPROVEMENTS.md file and add SECURITY.md Remove QUALITY_IMPROVEMENTS.md, add NuGet badge, and add SECURITY.md Dec 15, 2025
Copilot AI requested a review from Malcolmnixon December 15, 2025 18:33
Copy link
Contributor

@Malcolmnixon Malcolmnixon left a comment

Choose a reason for hiding this comment

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

Please consider expanding the SECURITY.md file with additional standard sections:

  • What to Expect
  • Security Update Process
  • Security Best Practices
  • Input Validation
  • Security Tools Used
  • Responsible Disclosure
  • Security Hall of Fame
  • Contact
  • Additional Resources

README.md Outdated
@@ -1,5 +1,6 @@
# SPDX Tool

![NuGet Version](https://img.shields.io/nuget/v/DemaConsulting.SpdxTool?style=plastic)
Copy link
Contributor

Choose a reason for hiding this comment

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

Please put the NuGet Version as the last shield, and also make it a link which takes the user to the nuget.org site for the package.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in c3292b4. The NuGet badge is now the last shield and links to https://www.nuget.org/packages/DemaConsulting.SpdxTool

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 15, 2025

Please consider expanding the SECURITY.md file with additional standard sections:

  • What to Expect
  • Security Update Process
    ...

Done in c3292b4. Added all suggested sections to SECURITY.md:

  • What to Expect
  • Security Update Process
  • Security Best Practices
  • Input Validation
  • Security Tools Used
  • Responsible Disclosure
  • Security Hall of Fame
  • Contact
  • Additional Resources

Copilot AI changed the title Remove QUALITY_IMPROVEMENTS.md, add NuGet badge, and add SECURITY.md Remove QUALITY_IMPROVEMENTS.md, add NuGet badge, and add comprehensive SECURITY.md Dec 15, 2025
Copilot AI requested a review from Malcolmnixon December 15, 2025 18:41
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
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