-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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: Add README for some newly added packages #17283
Conversation
Thanks for taking the time to open a PR!
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @jennifer-shehane
This was indeed needed.
@lmiller1990 can you review the runner-shared readme
The rest is great with me.
Test summaryRun details
View run in Cypress Dashboard ➡️ FlakinessThis comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard |
@@ -19,9 +20,11 @@ | |||
/packages/rewriter/ @cypress-io/test-runner | |||
/packages/root/ @cypress-io/test-runner | |||
/packages/runner/ @cypress-io/test-runner | |||
/packages/runner-shared/ @cypress-io/test-runner |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we also add a runner-ct code owner and respective GH team?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lmiller1990 Yah, was leaving that to the CT team to decide if you want to have your team pinged whenever the code is touched in the packages you 'own'. It's been working well for us because things opened by outside contributors or other teams is pretty obvious if it touches something we should look at without looking through all the files.
Additional Details
We want to ensure all newly added packages are properly documented for open source contributors and our own team by adding a README that describes:
For a good example, see the reporter/README.md.