One issue we are struggling with is testing for regressions.
After a change to the code, the only way to know nothing broke is to manually run the app, and test the various functionalities that it should offer.
The issue with this, is that it's really easy to miss something.
For example after #56 , ctrl-z and ctrl-y (undo/redo) broke. But since they weren't manually tested, it was merged into main.
To solve this, some sort of a manual QA routine should be created.
This is a checklist describing the steps that need to be taken to ensure the app is functioning as it should be.
This way we can run through this routine in each PR, and somewhat know that the crucial parts of the app didn't break.
Document structure
The checklist needs to be written in markdown format, and should look something like this:
- [ ] Create 3 vertices
- [ ] Delete 1 vertex using mass selection
- [ ] Delete 1 vertex using right click
- [ ] Change color of 1 vertex using right click
- [ ] Undo 3 times
.
.
.
It should be added to this file: https://github.com/YotamAshman/Graphos/blob/main/.github/pull_request_template.md
Under the last section mentioning checklist.
One issue we are struggling with is testing for regressions.
After a change to the code, the only way to know nothing broke is to manually run the app, and test the various functionalities that it should offer.
The issue with this, is that it's really easy to miss something.
For example after #56 , ctrl-z and ctrl-y (undo/redo) broke. But since they weren't manually tested, it was merged into main.
To solve this, some sort of a manual QA routine should be created.
This is a checklist describing the steps that need to be taken to ensure the app is functioning as it should be.
This way we can run through this routine in each PR, and somewhat know that the crucial parts of the app didn't break.
Document structure
The checklist needs to be written in markdown format, and should look something like this:
It should be added to this file: https://github.com/YotamAshman/Graphos/blob/main/.github/pull_request_template.md
Under the last section mentioning checklist.