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

Docs: Updating package readme with project composer package requirement for use in new projects #37355

Merged
merged 3 commits into from May 14, 2024

Conversation

coder-karen
Copy link
Contributor

Proposed changes:

  • This PR updates the package README.md to add additional info on requiring a package in a project's composer.json file, plus updating project versions and rebuilding, in order to be able to then use that package in another project.

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

p1715621684054849/1715618744.314119-slack-C05PV073SG3

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

Testing instructions:

  • Proof-read - the info is based on this Slack thread: p1715621684054849/1715618744.314119-slack-C05PV073SG3

Copy link
Contributor

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.

@coder-karen coder-karen marked this pull request as ready for review May 13, 2024 18:09
@coder-karen coder-karen added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] In Progress labels May 13, 2024
@jeherve jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels May 14, 2024
@jeherve jeherve merged commit 4424768 into trunk May 14, 2024
48 checks passed
@jeherve jeherve deleted the update/package-readme-requiring-package-first-step branch May 14, 2024 05:54
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants