Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor and update #2

Merged
merged 6 commits into from
Nov 15, 2023
Merged

Refactor and update #2

merged 6 commits into from
Nov 15, 2023

Conversation

alphaolomi
Copy link
Owner

@alphaolomi alphaolomi commented Nov 15, 2023

Summary

This pull request introduces several enhancements and new features to the alphaolomi/mrz PHP library. It notably includes the addition of GitHub funding information, an extensive testing setup via GitHub Actions for PHP versions 8.1 and 8.2 across various platforms, and a revision of the .gitignore file to align with best practices. The changes aim to streamline the development process, enhance code quality, and improve community engagement.

Changes

  1. GitHub Funding: A new FUNDING.yml file has been added to the .github directory, enabling the GitHub Sponsors button for the repository. This change opens up opportunities for community sponsorship, supporting the ongoing development and maintenance of the project.

  2. Testing Setup: The project now includes a comprehensive testing setup, implemented via GitHub Actions. The workflow, defined in run-phpunit-tests.yml, executes tests across a matrix of operating systems (Ubuntu and Windows) and PHP versions (8.1, 8.2), ensuring compatibility and robustness across different environments.

  3. .gitignore Revision: The .gitignore file has been updated to exclude additional files and directories such as .php_cs, .phpunit.result.cache, and composer.lock, among others. This update prevents unnecessary files from being tracked by Git, keeping the repository clean and focused on source code.

  4. Miscellaneous: Minor adjustments and improvements have been made to the documentation and codebase to enhance clarity and maintainability.

Impact

These changes are expected to positively impact the project by:

  • Enhancing Community Engagement: Through the GitHub Sponsors program.
  • Improving Code Quality and Reliability: By establishing a robust testing framework.
  • Maintaining a Clean Repository: By revising the .gitignore file.

Next Steps

  • Community Feedback: Encourage community feedback and contributions to further refine and enhance the library.
  • Continuous Integration: Monitor and optimize the GitHub Actions workflows for efficiency and coverage.

@alphaolomi alphaolomi self-assigned this Nov 15, 2023
@alphaolomi alphaolomi added the good first issue Good for newcomers label Nov 15, 2023
@alphaolomi alphaolomi merged commit 8dbfe51 into main Nov 15, 2023
8 checks passed
@alphaolomi alphaolomi deleted the update branch November 15, 2023 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant