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

Include VIP Coding Standards with 10up Default. #25

Merged
merged 1 commit into from
Jan 2, 2023

Conversation

peterwilsoncc
Copy link

@peterwilsoncc peterwilsoncc commented Dec 14, 2022

Description of the Change

Since 10up/phpcs-composer@5f9ac99 the 10up Default coding standards require the WordPress VIP sniffs be installed. This includes the sniffs with the 10up-Default ruleset.

Closes #24

How to test the Change

Changelog Entry

Fixed - Include WP VIP coding standards with 10up-Default sniffs.

Credits

Props @peterwilsoncc

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests pass.

@peterwilsoncc peterwilsoncc marked this pull request as ready for review December 14, 2022 23:19
@peterwilsoncc peterwilsoncc self-assigned this Dec 14, 2022
Copy link

@cadic cadic left a comment

Choose a reason for hiding this comment

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

LGTM.

Works as expected: 10up/simple-podcasting@1a97247

May produce new errors and warnings on existing projects because of rulesets change.

@cadic cadic added this to the Future Release milestone Dec 15, 2022
@peterwilsoncc
Copy link
Author

LGTM.

Works as expected: 10up/simple-podcasting@1a97247

May produce new errors and warnings on existing projects because of rulesets change.

@cadic @dkotter Do you think we should hold of merging for now and consider changing to using numbered versions in the OSP repos, rather than stable?

@dkotter
Copy link
Collaborator

dkotter commented Dec 20, 2022

Do you think we should hold off merging for now and consider changing to using numbered versions in the OSP repos, rather than stable?

Hmm... yeah, not sure here. I recently thought that we should change all our public Actions to use version numbers in their releases, which seems to be the standard there (so instead of including stable or a release like 2.0.0, you include v1 or v2. I don't think our Actions work like this right now).

That's a slightly different, though similar, thing then what's at play here. The concern as I see it here is if we merge this in, it could start causing failures on existing projects due to the new rules. While it would be great to update any project that uses this Action to reference a tagged release instead of stable, not sure how realistic that is.

I guess I lean towards merging this in and not seeing it as a bad thing if new issues are flagged that need fixed. But then would love to get on a more normal release pattern (and update docs) so projects aren't loading straight from stable. Any thoughts on this @jeffpaul?

@jeffpaul jeffpaul modified the milestones: Future Release, 1.5.0 Dec 22, 2022
@jeffpaul
Copy link
Member

  1. I'm fine merging this in.
  2. I'm fine with projects referencing stable if we effectively want to be on the latest version of an action.
  3. I'm also with projects referencing a specific release branch, e.g. v2, if we want to maintain functionality and avoid breaking changes.

So, kinda saying... YOLO I guess?

@peterwilsoncc
Copy link
Author

Thanks Jeff. YOLO!

@peterwilsoncc peterwilsoncc merged commit db06895 into develop Jan 2, 2023
@peterwilsoncc peterwilsoncc deleted the fix/24-add-vipcs-to-10up-default branch January 2, 2023 22:28
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.

10up-Default coding standards require WP VIP standards be installed.
4 participants