docs: add OpenSSF Best Practices badge and install/reporting pointers#100
Merged
Conversation
Insert the OpenSSF Best Practices badge (project 13567) right before the OpenSSF Scorecard badge, add an Installation section with the `dotnet add package FirstClassErrors` one-liner, and a "Feedback & contributing" section routing bug reports and feature requests to the GitHub issue tracker (and security reports to SECURITY.md). Mirrored in the French translation (doc/README.fr.md) to keep it in sync. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014W1zrcBNy3jEs8ngAQKwZg
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
2 participants
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.
Summary
Adds the OpenSSF Best Practices badge to the README (immediately before the OpenSSF Scorecard badge), plus a short Installation one-liner and a Feedback & contributing pointer so users know how to install the package and where to report bugs or request features.
Type of change
Changes
bestpractices.dev/projects/13567) between thecodeqland OpenSSF Scorecard badges.## 📦 Installationsection with thedotnet add package FirstClassErrorsone-liner.## 🐛 Feedback & contributingsection routing bug reports / feature requests to the GitHub issue tracker, contributions toCONTRIBUTING.md, and security reports toSECURITY.md.doc/README.fr.md).Testing
dotnet build FirstClassErrors.slndotnet test FirstClassErrors.slnFirstClassErrors.Analyzers.UnitTests)Documentation-only change (Markdown); no build or test commands were run.
Documentation
doc/updateddoc/README.fr.md) updated if user-facing behavior changedRelated issues
🤖 Generated with Claude Code
https://claude.ai/code/session_014W1zrcBNy3jEs8ngAQKwZg
Generated by Claude Code