Skip to content

Draft for QA Process for PRs

Danny Baez edited this page Apr 22, 2026 · 4 revisions

In order to reduce Un-tested / Buggy PRs merged, I propose a serie of changes for applying some kind of quality standard in PRs

Quality Assurance Process for PRs

QAP for PRs is a serie of process for ensuring PR's are tested and can be correctly registered for future reference. It includes:

  1. Each PR should have a test modified, added or deleted depending of the PR specifications
  2. When we modificate a feature, we should notate it in an example and also add a comment showcasing new feature/difference

When a change is made in any feature of KAPLAY, the following process would be adding a test in tests/, or modifying one

A test file added/modified is required even if there's an example that covers the same feature, this is because examples are for learners and users, and tests is for internal usage.

Adding a test

/**
 * @title A title that explains what the test is for (Jump)
 * @includes A list of functions, names, included for reference (body, area, BodyCompOpt)
 */

// PR #1008 Feature Showcase
kaplay();

const startY = 0;
const bean = add([ pos(0, startY) ]);

bean.jump();

onUpdate(() => {
    if(bean.pos.y != startY) {
        debug.log("test passed")
    }
});

Modify a test

/**
 * @title A title that explains what the test is for (Jump)
 * @includes A list of functions, names, included for reference (body, area, BodyCompOpt)
 */

// PR #1008 Feature Showcase
kaplay();

const startY = 0;
const bean = add([ pos(0, startY) ]);

bean.jump();

onUpdate(() => {
    if(bean.pos.y != startY) {
        debug.log("test passed")
    }
});

Clone this wiki locally