buggregator / trap

Buggregator local debug server for PHP projects as composer package
https://buggregator.dev
BSD 3-Clause "New" or "Revised" License
102 stars 8 forks source link

Add Rector to CI #133

Open Kaspiman opened 5 days ago

Kaspiman commented 5 days ago

What was changed

Add Rector to CI. Now only for one directory - src/Client.

Why?

Because this world needs more static analysis!

image

lotyp commented 5 days ago

@Kaspiman

First of all, thank you for your contribution.

Regarding rector, it has already been added into my template package here:

https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/refactoring.yml

and also it is used in this package:

https://github.com/cycle/active-record/blob/master/.github/workflows/refactoring.yml

Could you please, instead of modifying static-analysis.yml file, create new one, like it was done in these two packages?

Name it refactoring.yml and copy contents from here: https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/refactoring.yml

Also better to stick to full versions of actions in CI files and use renovatebot or dependabot to do continuous health checks and updates.

lotyp commented 2 days ago

@Kaspiman, I see that you did some changes—nice work!

There are a couple of things to fix from the DX (Developer Experience) side:

  1. Squash Commits: Can you squash your commits locally and then force push your branch so that there is only one commit?

  2. Conventional Commits: We use conventional commits for this project. Please rename your commit message from "Add Rector to CI" to "ci: add rector workflow". This format is important as we automatically generate the CHANGELOG.md file from commit messages.

Additionally, I noticed that we are missing a CONTRIBUTING.md file in this repository. This is a good opportunity for me đŸ˜… to create a new issue to add this file.

Right now you can check CONTRIBUTING.md here:

I will add this file also to this repository.

Update:

Created separate issue: https://github.com/buggregator/trap/issues/135