OpenCXL Code Commit Checklist

[kyeyoon-eeum]

To maintain high quality of the SW, the following tests must pass prior to code commit.

opencxl-core

pytest

• Must pass all test cases that run on make test.
• Add test cases for the new code.
• Must hit 100% code coverage for the new code.

pylint

• Must pass make lint.

black

• Must comply with PEP8 standards.
• Perform make format to auto-format prior to commit.

For both opencxl-qemu and opencxl-core

• All of the steps on OpenCXL with QEMU Host must successfully execute and function properly.
• Changes that introduce compatibility issues (e.g. packet format / sequence changes), must be addressed by either:
  • Making a complementary change to address the compatibility immediately. e.g. To opencxl-qemu, if a proposed change in opencxl-core would cause breakage (and vice versa).
    OR
  • Notify the maintainer by filing a GitHub "Issue" ticket with detailed explanation of the compatibility.