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

[DX] Improve contribution experience #101

Merged
merged 9 commits into from
Oct 3, 2024
Merged

Conversation

yoannmoinet
Copy link
Member

@yoannmoinet yoannmoinet commented Sep 30, 2024

What and why?

We were missing some documentation.
Some of our tooling was outdated and slipped through the cracks.

How?

  • Add documentation about testing.
  • Add documentation about internal plugins.
  • Fix generation of ToC.
  • Factorise Global Context types.
  • Some small updates.

@yoannmoinet yoannmoinet marked this pull request as ready for review September 30, 2024 13:56
@yoannmoinet yoannmoinet requested a review from a team as a code owner September 30, 2024 13:56
@yoannmoinet yoannmoinet removed the request for review from a team September 30, 2024 13:56
@yoannmoinet yoannmoinet changed the title [Doc] Add some doc [DX] Improve contribution experience Oct 1, 2024
README.md Outdated
rawConfig?: any;
variant?: string; // Major version of the bundler (webpack 4, webpack 5)
variant: string; // Major version of the bundler (webpack 4, webpack 5)
Copy link
Member

Choose a reason for hiding this comment

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

might be nice to tell the user that this will be an empty string for other bundlers (IIUC)

const variant =
        meta.framework === 'webpack' ? (meta.webpack.compiler['webpack'] ? '5' : '4') : '';

Copy link
Member Author

Choose a reason for hiding this comment

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

Good call.

Base automatically changed from yoann/internal-injection-plugin to master October 2, 2024 10:06
@yoannmoinet yoannmoinet merged commit 45624e5 into master Oct 3, 2024
5 checks passed
@yoannmoinet yoannmoinet deleted the yoann/add-some-doc branch October 3, 2024 13:05
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.

2 participants