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

codesniffer: Stop suppressing Commenting.WrongStyle in Jetpack-Tests #37290

Merged
merged 1 commit into from
May 8, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented May 8, 2024

Proposed changes:

Phan depends on doc comments using /** openers. While we often don't bother with doc comments in tests, where we do have them we should format them correctly.

The existing cases mostly fell into a few categories:

  • Actual doc comments.
  • "Section" separators being confused for function comments. Converted these to a /** ... **/ style to make the sniff happy with them.
  • Useless comments about how to use phpunit --filter. Removed these.
  • Useless comments basically repeating the test function name. Removed these too.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

None. But see #37122 where chasing missing WrongStyle sniffs led to another fix.

Does this pull request change what data or activity we track or use?

No

Testing instructions:

  • CI happy?

Phan depends on doc comments using `/**` openers. While we often don't
bother with doc comments in tests, where we do have them we should
format them correctly.

The existing cases mostly fell into a few categories:

* Actual doc comments.
* "Section" separators being confused for function comments. Converted
  these to a `/** ... **/` style to make the sniff happy with them.
* Useless comments about how to use `phpunit --filter`. Removed these.
* Useless comments basically repeating the test function name. Removed
  these too.
@anomiex anomiex added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial [Pri] Low labels May 8, 2024
@anomiex anomiex requested a review from a team May 8, 2024 17:55
@anomiex anomiex self-assigned this May 8, 2024
@anomiex anomiex enabled auto-merge (squash) May 8, 2024 17:55
Copy link
Contributor

github-actions bot commented May 8, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the fix/codesniffer-Jetpack-Tests-WrongStyle branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack fix/codesniffer-Jetpack-Tests-WrongStyle
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added [Package] Codesniffer [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests labels May 8, 2024
Copy link
Contributor

github-actions bot commented May 8, 2024

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for June 4, 2024 (scheduled code freeze on June 3, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@anomiex anomiex merged commit b54e2be into trunk May 8, 2024
58 checks passed
@anomiex anomiex deleted the fix/codesniffer-Jetpack-Tests-WrongStyle branch May 8, 2024 19:01
@github-actions github-actions bot added this to the jetpack/13.5 milestone May 8, 2024
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label May 8, 2024
pkuliga pushed a commit that referenced this pull request May 9, 2024
…37290)

Phan depends on doc comments using `/**` openers. While we often don't
bother with doc comments in tests, where we do have them we should
format them correctly.

The existing cases mostly fell into a few categories:

* Actual doc comments.
* "Section" separators being confused for function comments. Converted
  these to a `/** ... **/` style to make the sniff happy with them.
* Useless comments about how to use `phpunit --filter`. Removed these.
* Useless comments basically repeating the test function name. Removed
  these too.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Codesniffer [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Low [Tests] Includes Tests [Type] Janitorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants