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

Some style and general improvements #8

Open
wants to merge 34 commits into
base: Main
Choose a base branch
from

Conversation

kudashevs
Copy link

@kudashevs kudashevs commented Apr 9, 2024

Hello,

It wasn't possible to make this PR small, sorry. It fixes a lot of formatting issues; that's why it might seem bloated, but it really isn't.

So, I would like to propose some style and general improvements to the project. For your convenience, I'm going to list them in the same order as the Files changed tab shows:

  • fix the .editorconfig PHP files wildcard pattern and apply the rules to all the PHP files (mostly a new line at the end of a file)
  • apply the .editoconfig rules to other files (including .yml and .json files)
  • update build.yml workflow switch to ubuntu-latest
  • update build.yml workflow add support for new PHP (8.2, 8.3) and PHPUnit (10, 11) versions
  • update .gitignore add new exclusions (including composer.lock - explanation in the next improvement)
  • remove the composer.lock file from the project (it is not recommended to store it in the repo for libraries)
  • update README.md update the composer command (composer require is more common)
  • update README.md update links (some of the links don't work without the https:// prefix)
  • update composer.json move the Tests namespace to the development environment
  • update composer.json add a scripts section (it allows running tests through the composer, very convenient)
  • fix some inconsistencies in code formatting and indentations

If this PR is too big, I can try to divide it into three smaller ones. @isidore let me please know, if you need any help with this PR.

kudashevs added 30 commits April 9, 2024 14:01
Without https the link to the blog doesn't work.
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @kudashevs - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Docstrings: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

@@ -67,7 +67,7 @@ Examples
---
ApprovalTests eats it own dogfood, so the best examples are in the source code itself.

None the less, Here's a quick look at some
None the less, here's a quick look at some
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick (typo): Fixing the typo in 'None the less' improves the document's professionalism.

Copy link
Author

@kudashevs kudashevs Apr 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'd better ask the author of the text, not me, why they've used this interesting verbiage.
And this is actually the archaic way of spelling "nonetheless", so why not?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants