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

chore: update CONTRIBUTING.md #33138

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Conversation

dgozman
Copy link
Contributor

@dgozman dgozman commented Oct 16, 2024

No description provided.

This comment has been minimized.

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
@dgozman dgozman merged commit a2a5b10 into microsoft:main Oct 17, 2024
29 checks passed
Copy link
Contributor

Test results for "tests 1"

6 flaky ⚠️ [firefox-library] › library/trace-viewer.spec.ts:1140:1 › should ignore 304 responses @firefox-ubuntu-22.04-node18
⚠️ [playwright-test] › ui-mode-test-setup.spec.ts:98:5 › should show errors in config @macos-latest-node18-1
⚠️ [installation tests] › playwright-electron-should-work.spec.ts:44:5 › should work when wrapped inside @playwright/test and trace is enabled @package-installations-macos-latest @playwright/test
⚠️ [installation tests] › playwright-test-package-managers.spec.ts:54:5 › npm: uninstalling ct removes playwright bin @package-installations-macos-latest
⚠️ [chromium-page] › page/page-event-popup.spec.ts:149:3 › should not treat navigations as new popups @ubuntu-20.04-chromium-tip-of-tree
⚠️ [webkit-library] › library/browsercontext-viewport-mobile.spec.ts:116:5 › mobile viewport › default mobile viewports to 980 width @webkit-ubuntu-22.04-node18

35989 passed, 624 skipped
✔️✔️✔️

Merge workflow run.

@pengooseDev
Copy link
Contributor

The CONTRIBUTING guide is much easier to read now! Thanks for the update. :)
I have a few quick questions!


1. *namespace* is put in parenthesis after label and is optional. Must be lowercase.
1. *title* is a brief summary of changes.
1. *description* is **optional**, new-line separated from title and is in present tense.
1. *footer* is **optional**, new-line separated from *description* and contains "fixes" / "references" attribution to github issues.
  1. [ lines: 91~94, 132~135 ] All the numbering is set to 1, just wanted to point that out in case it's unintentional.

  2. Just a suggestion: I initially had difficulty since it's my first time seeing dynamically generated docs (e.g., docs/src/test-api) and types (e.g., utils/generate_types). A mention of this in the CONTRIBUTING guide could help future contributors.

@dgozman
Copy link
Contributor Author

dgozman commented Oct 17, 2024

@pengooseDev Thank you!

All the numbering is set to 1, just wanted to point that out in case it's unintentional

That's intentional, markdown handles it just right.

I initially had difficulty since it's my first time seeing dynamically generated docs (e.g., docs/src/test-api) and types (e.g., utils/generate_types).

There is the following line currently, but it's not very prominent:
Note that some files are generated by the build, so the watch process might override your changes if done in the wrong file. For example, TypeScript types for the API are generated from the [docs/src](https://github.com/microsoft/playwright/blob/main/docs/src)

If you have any specific ideas on improving the guide, I would love to review a PR!

@pengooseDev
Copy link
Contributor

@dgozman
The CONTRIBUTING guide you've written already does a great job of outlining the process of creating a PR by effectively using header(##). 😀
I believe adding subHeader(###) under the ## Make a change section could further emphasize key points and make the flow of code changes more explicit.

This is just a tiny suggestion, so feel free to disregard it if it doesn't align with teams visions. :) Thx!

Example

### TypeScript Type Generation

If your changes involve TypeScript types, ensure to modify the corresponding files in [`docs/src`](https://github.com/microsoft/playwright/blob/main/docs/src).
Note that some files are generated by the build, so the watch process might override your changes if done in the wrong file. For example, TypeScript types for the API are generated from this directory.

### Linting

Coding style is fully defined in [.eslintrc](https://github.com/microsoft/playwright/blob/main/.eslintrc.js). Before creating a pull request, or at any moment during development, run linter to check all kinds of things:
  ```bash
  npm run lint

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

Successfully merging this pull request may close these issues.

3 participants