Improve documentation - Githubissues

okteto / docker-desktop-extension

Docker Extension for Okteto

Apache License 2.0

5 stars 4 forks source link

Open boradesanket13 opened 2 years ago

boradesanket13 commented 2 years ago

Describe the bug Improve documentation of README.md and contributing.md

Additional context

Add badges for no. of forks, stars
Write prior documentation in pointwise manner in short
Add link to contributing.md in readme
Add standard Github workflow commands in the CONTRIBUTING.md (opening issues, get assigned, fork, create clone, add, commit, creating PRs).
It will provide new potential project contributors with a short guide to how they can help with your project.

pchico83 commented 2 years ago

@Sanket1308 this would be awesome, would you want to take care of it?

boradesanket13 commented 2 years ago

Yes, @pchico83!🚀

pchico83 commented 2 years ago

Yes, @pchico83!🚀

@Sanket1308 awesome, I assigned the issue to you, thanks!

GloriaOkeke commented 2 years ago

Hey @pchico83 I'll like to work on contributing.md. Could you assign me please?

pchico83 commented 2 years ago

Hey @pchico83 I'll like to work on contributing.md. Could you assign me please?

@GloriaOkeke I already assigned it @boradesanket13. If you have something in mind, open a more specific issue and I will assign it to you