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

Correct wrong example for watch in CONTRIBUTING.md #5971

Merged

Conversation

martinfrancois
Copy link
Contributor

Proposed changes

I noticed the CONTRIBUTING.md mentions:

npm run watch:pkg @wdio/runner

While the following line mentions:

npm run watch <package-name>

Since the npm script watch:pkg doesn't exist, I guess it was probably refactored at some time to watch (as this is the one that works and is present) and it was accidentally only changed in one place. Also, @wdio/runner doesn't work, wdio-runner must be used in this instance. I updated the CONTRIBUTING.md to reflect this.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • I have added proper type definitions for new commands (if appropriate)

Further comments

Reviewers: @webdriverio/project-committers

@martinfrancois martinfrancois added Docs 📖 PR: Docs 📝 PRs that contain changes to the documentation Hacktoberfest Curated issues which are well scoped and ready to be worked on as part of Hacktoberfest and removed Docs 📖 labels Oct 11, 2020
Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

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

👍

@christian-bromann christian-bromann merged commit 8986a6b into webdriverio:master Oct 11, 2020
@martinfrancois martinfrancois deleted the contributing-watch branch October 11, 2020 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest Curated issues which are well scoped and ready to be worked on as part of Hacktoberfest PR: Docs 📝 PRs that contain changes to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants