Skip to content

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

Merged
jrfnl merged 3 commits into
PHPCSStandards:masterfrom
potherca-contrib:issues/123-qa-details
Jan 30, 2022
Merged

jrfnl merged 3 commits into
PHPCSStandards:masterfrom
potherca-contrib:issues/123-qa-details

Conversation

@Potherca

Copy link
Copy Markdown
Member

Fixes #123

@Potherca
Potherca requested a review from jrfnl January 31, 2021 14:49
@Potherca Potherca self-assigned this Jan 31, 2021
@Potherca Potherca mentioned this pull request Jan 31, 2021
4 tasks done
@Potherca

Potherca commented Sep 7, 2021

Copy link
Copy Markdown
Member Author

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

@jrfnl

jrfnl commented Jan 27, 2022

Copy link
Copy Markdown
Member

@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
Copy Markdown
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

jrfnl commented Jan 29, 2022

Copy link
Copy Markdown
Member

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

jrfnl commented Jan 29, 2022

Copy link
Copy Markdown
Member

See: potherca-contrib#2

CONTRIBUTING: update the QA automation information
@Potherca

Copy link
Copy Markdown
Member Author

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

@jrfnl jrfnl left a comment

Copy link
Copy Markdown
Member

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

Development

Successfully merging this pull request may close these issues.

Document QA and development details

2 participants