Skip to content

Mention composer ci and composer list in CONTRIBUTING.md #815

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

Open
JakeQZ opened this issue Jan 26, 2025 · 0 comments
Open

Mention composer ci and composer list in CONTRIBUTING.md #815

JakeQZ opened this issue Jan 26, 2025 · 0 comments
Labels
developer-specific Issues that only affect maintainers, contributors, and people submitting PRs documentation

Comments

@JakeQZ
Copy link
Collaborator

JakeQZ commented Jan 26, 2025

#807 removes contributor-related content from README.md. Most if it is now already covered in CONTRIBUTING.md. However, some nuances are not:

  • run composer ci to run all static and dynamic CI checks.

Details of other Composer scripts available (e.g. to run one specific CI check) are provided with composer list.

The guidelines currently only mention composer ci:tests:unit and composer ci:static, and do so in separate sections. Running both does presently amount to the equivalent of composer ci, but in future might not ecompass all that it does.

composer ci is particularly important to mention. If a proposed PR passes this, then it's likely the GitHub CI action checks will also pass, and the PR can be immediately reviewed. GitHub does not run the CI actions for PRs submitted by a non-collaborator until they are manually approved to be run (by a collaborator). This means a contributor does not get immediate feedback if there are some CI checks still failing. The eventual feedback they get will come via email and may be treated as spam. That may have been the case with #389.

Following on from that, it would perhaps also be helpful to outline the above in the contributing guidelines. And perhaps for collaborators to post a note to the PR if the checks fail after manual triggering - I have a feeling that emails for manual comments are routed differently to automated ones regarding CI failures; in any case, a hand-typed comment is less likely to be treated as spam.

@JakeQZ JakeQZ added developer-specific Issues that only affect maintainers, contributors, and people submitting PRs documentation labels Jan 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer-specific Issues that only affect maintainers, contributors, and people submitting PRs documentation
Projects
None yet
Development

No branches or pull requests

1 participant