Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Phase 1] Refactor 0x04h-Testing-Code-Quality.md #2212

Closed
cpholguera opened this issue Sep 5, 2022 · 1 comment · Fixed by #2381
Closed

[Phase 1] Refactor 0x04h-Testing-Code-Quality.md #2212

cpholguera opened this issue Sep 5, 2022 · 1 comment · Fixed by #2381

Comments

@cpholguera
Copy link
Collaborator

  1. Go through each test case (1 MR per chapter)
  2. Extract any general information and put it to the theory overview
  • Each chapter must have a “## Overview” section and then several “## Testing …(MSTG-XXX-YY)” sections

  • Strategy 1: move theory to chapter overview

  • Strategy 2: move theory to general chapter overview

  1. Only leave a test description on each test (see notes)

Notes:

  • Follow the style guide
  • If it helps you may already “pre-split” some tests by using:
    • “### “ subsections (example)
    • or “-” bullet point lists if there’s not enough details yet (example, right before the linked test there’s a list with several “- Check …”).
@iotaaxel
Copy link
Contributor

iotaaxel commented Nov 1, 2022

Working on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants