Repository navigation
docs: refine language for clarity and conciseness - #38
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Several documentation inaccuracies, an unresolved editorial marker, and unsynchronized source files remain.
Review effort: Lite
Findings: 2
Open (4)
What changed in this PR
Refines the FIASSE framework documentation for clarity and conciseness.
Changes:
- Simplifies foundational principles and guidance.
- Clarifies roles, requirements, reviews, dependencies, and adoption.
- Condenses concluding and stakeholder guidance.
| File | Summary |
|---|---|
docs/securable_framework.md |
Revised framework language and explanations throughout. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Resolve the Section 4.5 conflict with PR #37: keep the PR's condensed Dependency Stewardship paragraph and practice bullets, carry over main's lead-in sentence for the SSEM attribute list, and leave out the duplicated "Avoid unnecessary dependencies" bullet introduced on main. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
… placeholder Address two Copilot review comments on PR #38 in Section 1.2 and 4.1.2: - NIST SSDF defines a core set of secure software development practices. It is not a security-program maturity model like BSIMM or OpenSAMM, so the scope paragraph now names it separately with an accurate description. - Replace the "[NEEDS: source for this claim]" editorial marker with a plainly stated observation. The paragraph's next sentence supplies the reasoning, so no appeal to unnamed practitioners is needed. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Reword policy on open-source dependencies and maintenance. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Clarify guidelines on managing dependencies and their impact on system reliability. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Updated the description of how requirements relate to security vulnerabilities and clarified the practices FIASSE uses to address various vulnerability classes. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Clarified the role of security expectations in preventing findings during implementation. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Remove two stray blank lines inside the "In practice" list in Section 4.5 so it renders as one list, and add the missing blank line after the Section 5.3 heading. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Regenerate docs/framework from docs/securable_framework.md with scripts/extract_fiasse_sections.py so the per-section files match the reworded document. Remove S4.6.0.md, which no longer has a source section since 4.5 and 4.6 were consolidated into Dependency Stewardship, and point llms.txt, code-index.md, and the securable-code skill at S4.5.0 instead. Refresh the llms.txt Docs titles to match the current headings (the sync script preserved titles from an older numbering) and move the description that belonged to "Aligning Security with Development" from the 2.4 entry to the 2.5 entry. Re-copy the skill's bundled framework files; update-framework.py --check passes. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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.
No description provided.