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

Fixes proof / Register

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

Adding a test

Depending of the PR adding a new feature / modifying an existent feature, we can use the folder tests/ for storing test files.

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

kaplay();

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

bean.jump();

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

A test file 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.

Clone this wiki locally