blenderskool / vyaakaran

📜 Visualize formal languages and automata
https://vyaakaran.now.sh
MIT License
35 stars 5 forks source link

Adding GitHub Workflow for running tests #18

Open vr-varad opened 1 week ago

vr-varad commented 1 week ago

Set up GitHub Actions for CI (tests on PRs) and CD (deploy on pushes).

blenderskool commented 1 week ago

Could you elaborate a bit more? There's already auto deploy configured on Vercel. There are no tests in the repository right now (would be a good idea to add it) for the CI workflow

vr-varad commented 1 week ago

Like while adding code to codebase we can check for lining errors, we can run code that has been changed by contributor to check for errors before adding it to code base,

vr-varad commented 1 week ago

We can add tests and if someone contributes to code, as soon as they add make a pr we can test it and if there is any error he/she will know we don't have to manually check code for correctness

blenderskool commented 1 week ago

Got it, this workflow makes sense. But it also requires us to have some testing setup in place which is missing right now 😅. It would better if we can setup unit testing(possibly with vitest) in compiler and editor with some unit tests to go with it before adding the workflow for it.

vr-varad commented 1 week ago

okay!! Can u assign me this issue? How about using jest or mocha chai which is more used?

blenderskool commented 1 week ago

Let me create a new issue for testing setup. This issue was for discussing GitHub workflows.

vr-varad commented 1 week ago

cool

vr-varad commented 1 week ago

@blenderskool can I start working on testing?

blenderskool commented 1 week ago

The issue for unit testing setup has been created here – #19. It also has some points on why Vitest is preferred for this project.