microsoft / code-with-engineering-playbook

This is the playbook for "code-with" customer or partner engagements
https://microsoft.github.io/code-with-engineering-playbook/
Creative Commons Attribution 4.0 International
2.23k stars 587 forks source link

Enhance NFRs Page by adding missing requirements and including examples #1053

Closed dgregoraz closed 2 months ago

dgregoraz commented 3 months ago

Pull Request Template

What are you trying to address

Enhancing the Non-Functional Requirements Capture page to categorize and incorporate missing NFR references when available, including several NFRs that were not specified in the playbook.

Checklist

READY TO PR? Use the check-list below to ensure your branch is ready for PR.

Note: You may see link check errors on pages you have not touched. This is normal, and due to either broken links or sites that reject link checker bots. The reviewer will help you get to a green state on these.

github-actions[bot] commented 3 months ago

🦙 MegaLinter status: ⚠️ WARNING

Descriptor Linter Files Fixed Errors Elapsed time
✅ MARKDOWN markdownlint 14 0 0.87s
⚠️ MARKDOWN markdown-table-formatter 14 1 0.32s
✅ MDLINKCHECK linkcheck 14 0 1.33s
⚠️ SPELL cspell 15 1 2.67s

See detailed report in MegaLinter reports _Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff_

_MegaLinter is graciously provided by OX Security_

dgregoraz commented 3 months ago

Thank you much for this content.

I added comments mainly on the markdown and folder structure, plus some typos. Feel free to reset the review once you have made the appropriate changes, and I can re-review or Shiran or Nick can review depending on who is available.

Done!