[🛠️] Add unit tests (jest)

[TheDanniCraft]

Is your feature request related to a problem? Please describe.
Currently, we don’t have automated tests set up, which makes it harder to ensure the code quality and reliability of new features or bug fixes introduced through Pull Requests (PRs). Manually testing each PR can be time-consuming and error-prone.

Describe the solution you'd like
I propose adding Jest as a testing framework to the project. This will allow us to write unit tests that automatically run each time a new PR is opened. These tests will ensure that the code works as expected and reduces the risk of introducing bugs in the codebase. The tests should run via a continuous integration pipeline (like GitHub Actions) to ensure every PR is tested before being merged.

Describe alternatives you've considered
-

Additional context
-

[Muhammad-Owais-Warsi]

Hey @TheDanniCraft,
I would love to contribute to this!

I have a question: Should the tests run before the user raises the PR, or should they run on GitHub itself?
I’ll be needing your assistance as this is my first time working on an issue like this.

Thanks!

[TheDanniCraft]

Hey @Muhammad-Owais-Warsi, 👋
Thanks so much for your interest in contributing to this issue! ❤️

The tests should ideally serve two purposes:

1. Self-testing before creating a PR: Running the tests locally helps ensure changes work as expected and don’t accidentally break anything.
2. Testing PRs on GitHub: The tests will also run automatically on GitHub as part of the CI workflow to verify everything in a consistent environment.

My plan is to aim for tests with good code coverage, ideally including mocked functions and API responses where needed, to make them reliable and efficient. That said, feel free to focus on what you’re comfortable with or what you can manage—every contribution helps!

Let me know if you have any questions or need guidance. I’m here to help! Looking forward to your contributions. 🚀

[Muhammad-Owais-Warsi]

Thanks a lot @TheDanniCraft . Actually I don't even know ehre to start from, I have gone through the jest documentation, but how do i test the functions inside the github.js file which need dynamic data.

[TheDanniCraft]

Thanks a lot @TheDanniCraft . Actually I don't even know ehre to start from, I have gone through the jest documentation, but how do i test the functions inside the github.js file which need dynamic data.

No worries, I’m not super familiar with jest either, but I think what we’ll need to do is mock the API responses to handle the dynamic data. This way, we can simulate how the functions behave without actually hitting the real API (Jest Mock Functions).

Feel free to give it a try, and let me know if you run into any issues—I’ll try my best to help out! 😊

[adeson33]

hey @TheDanniCraft
i have see your question in opire, i am a c++ engineer not familiar in jest framework. it sounds like you want build a CD system to run the unit test.If you need help , I can join you.
And by the way, I have a question in using the activity-log, why my operation in github readme log were always repeated,it's my generated log.

[adeson33]

hey @TheDanniCraft
I don't know which is the function point we have to test, or now the target is to build a automative test env. If we want to work together efficiently, i think you can provide us a list of test function points, and each of us can do a part.

[TheDanniCraft]

Hey @adeson33,

Thank you so much for your interest in helping out, I really appreciate it! ❤️

Regarding your issue with the activity-log: could you please create a separate issue for that? This will help us keep discussions focused and address your concern about the repeated logs more effectively.

As for the testing setup, the main goals are:

• Build an automated test environment to reliably find breaking changes (e.g., block merge of prs if they break the action).
• Allow contributors to self-test their code locally before submitting PRs to catch issues early.

I agree that having a clear list of test function points would make the process more efficient. However, I’ll admit I don’t have much experience with test coverage strategies, so I’m not sure what functions would make the most sense to test. If you or anyone else has suggestions for a good testing strategy, I’d love to hear them!

Let me know if you’d like to take on any part of this process or if you have ideas for how we should proceed—I’m happy to collaborate. 😊

[adeson33]

@TheDanniCraft
Of course i'd like to join you, i will create a seperate issue later. Oh, you don't have to be nervous about the test coverage strategies. In my work experience, you only have to make sure primary function point not wrong. And when other users or our team members discover the bug, we can add the operation to complement our unit test.

[Muhammad-Owais-Warsi]

That's great. I think the main functions are in the github.js file that fetches all the data and performs the operation. As @adeson33 suggested we can seperate the part for each of us and collaborate efficiently.