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.

Sign up for GitHub

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

Jump to bottom

Better document process how types are generated. #4948

Merged
merged 2 commits into from
Jan 15, 2020
Merged

Better document process how types are generated. #4948

merged 2 commits into from
Jan 15, 2020

Conversation

christian-bromann
Copy link
Member

Pre-check

Describe the improvement

I'd like to report

  • Unclear documentation
  • A typo
  • Missing documentation
  • Other

Description of the improvement / report
We should better document how types are generated, so we don't need to explain this process during PR reviews.

@christian-bromann christian-bromann added Docs 📖 help wanted Issues that are free to take by anyone interested good first pick a reasonable task to start getting familiar with the code base labels Jan 8, 2020
@IgorSasovets
Copy link
Contributor

That's a good idea. I'd also suggest you to update the existing tests examples, add more async/await cases. I can help you with it if you need

@christian-bromann
Copy link
Member Author

I can help you with it if you need

That would be much appreciated!

@christian-bromann christian-bromann self-assigned this Jan 15, 2020
@christian-bromann christian-bromann added PR: Docs 📝 PRs that contain changes to the documentation and removed good first pick a reasonable task to start getting familiar with the code base help wanted Issues that are free to take by anyone interested labels Jan 15, 2020
@christian-bromann christian-bromann requested a review from a team January 15, 2020 11:48
@christian-bromann christian-bromann added this to the v6 milestone Jan 15, 2020
mgrybyk
mgrybyk reviewed Jan 15, 2020
View reviewed changes
CONTRIBUTING.md Outdated

Whenever you change the types in these packages, make sure you re-generate the types with the command shown above. In order to ensure that packages where type definitions have changed are released we keep the generated type definition in source control.

### Adding Types for webdriverIO
Copy link
Member

Choose a reason for hiding this comment

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

should WebdriverIO start from uppercase here?

Copy link
Member Author

Choose a reason for hiding this comment

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

👍

mgrybyk
mgrybyk approved these changes Jan 15, 2020
View reviewed changes
Copy link
Member

@mgrybyk mgrybyk left a comment

Choose a reason for hiding this comment

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

LGTM

@codecov
Copy link

codecov bot commented Jan 15, 2020 •
edited
Loading

Codecov Report

Merging #4948 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #4948   +/-   ##
=======================================
  Coverage   99.42%   99.42%           
=======================================
  Files         210      210           
  Lines        5561     5561           
  Branches     1204     1204           
=======================================
  Hits         5529     5529           
  Misses         29       29           
  Partials        3        3

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5c6672c...be6980b. Read the comment docs.

@mgrybyk
Copy link
Member

mgrybyk commented Jan 15, 2020

Maybe we should also mention that types should be generated if there were any changes to js doc or protocols?

@christian-bromann
Copy link
Member Author

Maybe we should also mention that types should be generated if there were any changes to js doc or protocols?

I thought I covered this by

Whenever you change the types in these packages, make sure you re-generate the types with the command shown above.

@christian-bromann christian-bromann merged commit 451b31c into master Jan 15, 2020
@christian-bromann christian-bromann deleted the cb-document-type-generation branch January 15, 2020 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mgrybyk mgrybyk mgrybyk approved these changes

Assignees

@christian-bromann christian-bromann

Labels
Docs 📖 PR: Docs 📝 PRs that contain changes to the documentation
Projects
None yet
Milestone
v6
Development

Successfully merging this pull request may close these issues.
3 participants
@christian-bromann @IgorSasovets @mgrybyk