feat(tests): add GitHub Actions workflow for automated testing and co…

[sumansaurabh]

User description

…verage reporting

---

Description

• Introduced a GitHub Actions workflow for automated testing and coverage reporting.
• Enhanced the README with badges for test and coverage status, along with a detailed features section.
• Configured pytest for coverage reporting and updated the requirements file to include necessary testing libraries.

---

Changes walkthrough 📝

	Relevant files
Tests	test.yml Add GitHub Actions Workflow for Automated Testing                .github/workflows/test.yml Added GitHub Actions workflow for automated testing. Configured steps for setting up Python, installing dependencies, and running tests. Included coverage reporting and badge generation. +48/-0
Documentation	README.md Update README with Badges and Features                                      README.md Added badges for tests and coverage. Expanded features section with additional details. Included instructions for running tests. +16/-0
Enhancement	pytest.ini Configure pytest for Coverage Reporting                                    pytest.ini Added coverage settings for pytest. Specified test paths and patterns. +4/-1
Dependencies	requirements.txt Update Requirements for Testing Libraries                                requirements.txt Updated requirements with testing dependencies. Added specific versions for testing libraries. +9/-3

---

💡 Penify usage:
Comment /help on the PR to get a list of all available Penify tools and their descriptions

[penify-dev]

PR Review 🔍

⏱️ Estimated effort to review [1-5]	2, because the changes are primarily configuration and documentation updates, which are straightforward to review.
🧪 Relevant tests	Yes
⚡ Possible issues	No
🔒 Security concerns	No

[penify-dev]

PR Code Suggestions ✨

Category	Suggestion	Score
Best practice	Use a specific version tag for the GitHub push action to ensure stability Consider using a specific version tag for the ad-m/github-push-action to avoid potential breaking changes from future updates. .github/workflows/test.yml [45] -- uses: ad-m/github-push-action@master +- uses: ad-m/github-push-action@v0.0.3 Suggestion importance[1-10]: 8 Why: Using a specific version tag helps ensure stability and prevents unexpected breaking changes from future updates, which is a good practice in CI/CD workflows.	8
Possible issue	Add upper version constraints to testing libraries to prevent potential compatibility issues Ensure that the version constraints for the testing libraries are compatible with each other to avoid dependency conflicts. requirements.txt [7-10] --pytest>=7.0.0 --pytest-cov>=4.0.0 --coverage>=6.0.0 --coverage-badge>=1.1.0 +-pytest>=7.0.0,<8.0.0 +-pytest-cov>=4.0.0,<5.0.0 +-coverage>=6.0.0,<7.0.0 +-coverage-badge>=1.1.0,<2.0.0 Suggestion importance[1-10]: 7 Why: Adding upper version constraints can help prevent potential compatibility issues, which is important for maintaining a stable development environment.	7
Maintainability	Simplify the commit command to avoid unnecessary checks for changes The git diff command can be simplified by using git commit -m "Update coverage badge" directly without checking for changes, as it will not fail if there are no changes. .github/workflows/test.yml [41] -- git diff --quiet && git diff --staged --quiet || git commit -m "Update coverage badge" -a +- git commit -m "Update coverage badge" -a Suggestion importance[1-10]: 6 Why: While simplifying the command can improve readability, checking for changes before committing is a useful safeguard to avoid unnecessary commits, so this suggestion is not critical.	6
Enhancement	Enhance test feedback by stopping on the first test failure Consider adding a --maxfail option to the addopts to stop the test run after the first failure, which can speed up feedback during development. pytest.ini [8] -+addopts = --cov=penify_hook --cov-report=term --cov-report=xml ++addopts = --cov=penify_hook --cov-report=term --cov-report=xml --maxfail=1 Suggestion importance[1-10]: 5 Why: While adding --maxfail can enhance feedback during development, it is not essential for all testing scenarios, making this suggestion a minor enhancement.	5