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

Refactor docs and contribution guides #199

Merged
merged 17 commits into from
Nov 8, 2024

Conversation

jaggli
Copy link
Contributor

@jaggli jaggli commented Nov 4, 2024

Currently the code examples in community guidelines do not work, directories are wrong and the global scripts in the main monorepo package.json are inconsistent.

  • Make scripts consistent in main package.json
  • Fix contribution guidelines
  • Add link to docs in Readme
  • Separate development guides for next-yak and yak-swc
  • Remove some clutter
  • Update pnpm version to v9.12.3
  • Rename the contribution guides to CONTRIBUTION.md

contributing-guide.md Outdated Show resolved Hide resolved
Mad-Kat
Mad-Kat previously approved these changes Nov 4, 2024
@Mad-Kat
Copy link
Collaborator

Mad-Kat commented Nov 4, 2024

Thank you very much for this PR. Our readme, docs and examples need some love. LGTM

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
contributing-guide.md Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@jantimon
Copy link
Collaborator

jantimon commented Nov 4, 2024

thanks @jaggli the cleanup was really necessary 👍

@jantimon
Copy link
Collaborator

jantimon commented Nov 6, 2024

we should add

css-modules/postcss-modules-local-by-default#78
and
css-modules/postcss-modules-local-by-default#80

to the yak shaving section

Copy link

changeset-bot bot commented Nov 8, 2024

🦋 Changeset detected

Latest commit: dab650a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@jaggli jaggli changed the title Feature/refactor docs and guidelines Refactor docs and contribution guides Nov 8, 2024
Copy link

codspeed-hq bot commented Nov 8, 2024

CodSpeed Performance Report

Merging #199 will not alter performance

Comparing feature/refactor-docs-and-guidelines (dab650a) with main (bc7a02c)

Summary

✅ 2 untouched benchmarks

…timon/next-yak into feature/refactor-docs-and-guidelines
@jantimon jantimon self-requested a review November 8, 2024 14:56
@jantimon jantimon merged commit 82e86a0 into main Nov 8, 2024
7 checks passed
@jantimon jantimon deleted the feature/refactor-docs-and-guidelines branch November 8, 2024 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants