[DOC] - Readme file enhancement

Semalab / developer-skills-matrix-discord-bot

This is a bot that allows you to assess your skills with our developer rubric directly on discord

GNU Affero General Public License v3.0

11 stars 7 forks source link

[DOC] - Readme file enhancement #15

Closed Susmita-Dey closed 1 year ago

Susmita-Dey commented 2 years ago

What is incorrect in the documentation?

The README file neither contains any description of the bot nor about the project which could help newbies to contribute to this repository.

What should that text say?

The text should say:

A short description about the bot
A logo of sema/oswc
A line redirecting to the LICENSE file
A line to check for the CONTRIBUTING file
Thank You section for the Contributors having badge
Some emojis to encourage the contributors along with the above sections.

Additional information

No response

naomi-lgbt commented 2 years ago

Good idea!! Opening this up as a good first issue. 😁

AnujSsStw commented 2 years ago

hey can you say which fields are currently required like there is About The Project, then Installation, maybe Usage and License. Any other?

AnujSsStw commented 2 years ago

@nhcarrigan for now, you can check this out https://github.com/AnujSsStw/readme-testing/blob/main/README.md If you have any thoughts feel free to let me know.

MrHerbalizer commented 2 years ago

Hi, please check this file : https://github.com/MrHerbalizer/developer-rubric-discord-bot Have added a license badge. Instead of contributor's name with hyperlink, have added an image, which ideally should update daily (fingers crossed). Have added some info. Do share if you seek any changes/updates in the file.

naomi-lgbt commented 2 years ago

PRs are welcome - we encourage you to open draft PRs if you have work that is not ready to merge but needs a second set of eyes. 😁

MrHerbalizer commented 2 years ago

Gosh..!! Opened a PR instead of a draft PR. Please excuse my naivety..:/