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

docs: add contributing page #729

Merged
merged 18 commits into from
Sep 29, 2023
Merged

docs: add contributing page #729

merged 18 commits into from
Sep 29, 2023

Conversation

Haythamasalama
Copy link
Contributor

@Haythamasalama Haythamasalama commented Sep 23, 2023 •
edited
Loading

🔗 Linked issue

Resolves #325

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Added Contributing Page inspired by Nuxt

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@vercel
Copy link

vercel bot commented Sep 23, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
ui ✅ Ready (Inspect) Visit Preview Sep 29, 2023 9:05am

@Haythamasalama Haythamasalama marked this pull request as draft September 23, 2023 01:43
@Haythamasalama Haythamasalama marked this pull request as ready for review September 23, 2023 16:50
@MuhammadM1998
Copy link
Contributor

MuhammadM1998 commented Sep 24, 2023 •
edited
Loading

The dev script runs the dev server for the docs while play runs the dev server for the playground. Maybe it's better to include this info somewhere as it may be confusing? may also be worth it to rename them to dev:docs and dev:playground.

Also when running dev:prepare I get this warning twice in the console

WARN Duplicated imports "useComponentMeta", the one from 
"C:/Users/Muhammad/Desktop/ui/node_modules/.pnpm/[email protected][email protected]/node_modules/nuxt-component-meta/dist/runtime/composables/useComponentMeta.d.ts"
has been ignored

@Haythamasalama Volta.net
Copy link
Contributor Author

Haythamasalama commented Sep 24, 2023 •
edited
Loading

OK, I will split npm run dev and npm run play, and for the warning when running dev:prepare, could you please create an issue about it?

benjamincanac
benjamincanac reviewed Sep 28, 2023
View reviewed changes
Copy link
Member

@benjamincanac benjamincanac left a comment

Choose a reason for hiding this comment

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

Maybe we can mention to run typecheck alongside the lint?

@Haythamasalama
Copy link
Contributor Author

@benjamincanac done

@benjamincanac benjamincanac merged commit bbf3424 into nuxt:dev Sep 29, 2023
1 check passed
@Haythamasalama Haythamasalama deleted the docs/contrbuiting branch September 29, 2023 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benjamincanac benjamincanac benjamincanac approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Docs] Community section
3 participants
@Haythamasalama @MuhammadM1998 @benjamincanac