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

Add details regarding QA automation in CONTRIBUTING.md file. #133

Merged
merged 3 commits into from
Jan 30, 2022

Conversation

Potherca
Copy link
Member

Fixes #123

@Potherca
Copy link
Member Author

Potherca commented Sep 7, 2021

@jrfnl or @mjrider Does either of you have time to review my prose?

@jrfnl
Copy link
Member

jrfnl commented Jan 27, 2022

@Potherca Sorry that it's taken such a long time to get to this. I'd like to get this merged in before I pull the initial test setup PR.

Looking at it, it looks like some of the information is slightly out of date by now (Travis vs GH Actions and such). Have you got time to review and update it yourself ? Or would you like me to propose an update by adding a commit ?

@Potherca
Copy link
Member Author

If you've got time, feel free to add. I'll move future branches from my fork to here so they can be more easily edited.

* Replace the mention of Travis with GH Actions.
* Add information about PHP-Parallel-Lint to the "PHP" section.
* Use proper casing for tool names (in as far as I know it).
* Add a small explanation of what it does for each tool.
* Move the URLs for inline links to the bottom of each section.
@jrfnl
Copy link
Member

jrfnl commented Jan 29, 2022

If you've got time, feel free to add. I'll move future branches from my fork to here so they can be more easily edited.

I've created the update, but looks like the checkbox to allow maintainers to edit the PR has not been checked ?
A push to your fork on this PR branch is being rejected.

I'll send you a PR to update this PR 🙃

@jrfnl
Copy link
Member

jrfnl commented Jan 29, 2022

See: potherca-contrib#2

CONTRIBUTING: update the QA automation information
@Potherca
Copy link
Member Author

@jrfnl I've merged your MR so you can merge my MR. 😬

Copy link
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

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

Thanks @Potherca for adding this!

I do think that the non-PHP section may need a little more detail for people not using Act or Docker, but that can be added later. (I tried to get remark lint working locally yesterday and failed miserably)

For now, this is a great improvement already!

@jrfnl jrfnl merged commit ab0923f into PHPCSStandards:master Jan 30, 2022
@Potherca Potherca deleted the issues/123-qa-details branch January 30, 2022 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document QA and development details
2 participants