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: adding information to CONTRIBUTING.md that *.d.ts files are generated based on markdown (md) files #28338

Closed
dev-jonghoonpark opened this issue Nov 25, 2023 · 1 comment

Comments

@dev-jonghoonpark
Copy link
Contributor

Hello, I recently submitted my first pull request (#28231) regarding toPass timeout configuration.

When I first saw this project, I didn't anticipate that *.d.ts files would be generated through markdown(md) files. As a result, it took me more time to analyze the code.

At the top of the test.d.ts file, it is mentioned:
// This file is generated by /utils/generate_types/index.js
However, since the concept of generating *.d.ts files through md files was new to me, I hadn't considered that at all.

Adding information to the contributing document that *.d.ts files are generated based on md files could be helpful for beginners like me.

For example,

All API classes, methods, and events should have a description in docs/src.
Type declaration files (e.g. test.d.ts, testReporter.d., ...) created during the build process through the docs.

Adding this to the writing-documentation section would be appropriate.

To @dgozman , if this improvement direction is acceptable, please comment! I will submit the PR right away.

Thank you.

@pavelfeldman
Copy link
Member

Thank you for your suggestion. This would explain one of a thousands things that are known to maintainers and not known to the new contributors, so I don't think additional details like this in contributors guide would systematically help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants