docs: create project README - Githubissues

verde-rbx / verde

Verde synchronises files between Roblox Studio and your editor of choice

https://verde.quantix.dev/

Mozilla Public License 2.0

6 stars 0 forks source link

docs: create project README #19

Closed quantix-dev closed 1 year ago

quantix-dev commented 1 year ago

🔗 Linked issue

❓ Type of change

[x] 📖 Docs (updates to the documentation, readme or JSdoc annotations)
[ ] 🐞 Fix (a non-breaking change that fixes an issue)
[ ] 👌 Enhancement (improving an existing functionality like performance)
[ ] ✨ 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 a README.md and fixed link to contribution guidelines in pull request template.

🧪 Tests

[ ] I have added unit tests for this change.
[ ] I have made changes to existing unit tests.
[x] I have confirmed other areas are unaffected.

📝 Checklist

[ ] I have linked an issue or discussion.
[ ] I have updated the related documentation.
[x] I have reviewed my code and confirmed it follows the Contribution Guidelines