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(README): add and improve contributing guide, local development guide #860

Merged
merged 4 commits into from
Nov 22, 2023

Conversation

huynl-96
Copy link
Contributor

πŸ”— Linked issue

NA

❓ 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

Add development section to help newcomers easily setting up repo for contribution

πŸ“ Checklist

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

@vercel
Copy link

vercel bot commented Oct 25, 2023

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Updated (UTC)
ui βœ… Ready (Inspect) Visit Preview Nov 21, 2023 11:31pm

@MuhammadM1998
Copy link
Contributor

There's a contribution page already. Maybe it's better to enhance it https://ui.nuxt.com/getting-started/contributing

@huynl-96
Copy link
Contributor Author

Thanks for pointing out @MuhammadM1998 🀝 I was looking around the repo and couldn't find it πŸ˜…
Let me attach the contribution link to README and see if I can improve the guide any further πŸ™‡πŸ»β€β™‚οΈ

@benjamincanac benjamincanac marked this pull request as draft October 25, 2023 16:00
@huynl-96 huynl-96 changed the title docs(README): add development guide docs(README): add and improve contributing guide, local development guide Oct 30, 2023
@benjamincanac
Copy link
Member

@huynl-96 Not sure if you still have things to do on this, feel free to mark it as Ready for review when you're done 😊

@huynl-96 huynl-96 marked this pull request as ready for review November 21, 2023 23:25
@huynl-96
Copy link
Contributor Author

@benjamincanac Ready for review
Let me know if there is anything we can improve on this 🀝

@benjamincanac
Copy link
Member

I think it's fine like this, thanks for the improvements! 😊

@benjamincanac benjamincanac merged commit 10ec3d5 into nuxt:dev Nov 22, 2023
@huynl-96 huynl-96 deleted the docs/add-development-guide branch November 23, 2023 01:29
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