Skip to content

Updated README.md by adding README badges, license section, and contributing link#50

Open
somethinghere0 wants to merge 1 commit into
weval-org:mainfrom
somethinghere0:docs/readme-license-badges
Open

Updated README.md by adding README badges, license section, and contributing link#50
somethinghere0 wants to merge 1 commit into
weval-org:mainfrom
somethinghere0:docs/readme-license-badges

Conversation

@somethinghere0

Copy link
Copy Markdown

Description

Addresses the issue regarding missing README documentation, license visibility, and status badges.

Changes Made

  • Added MIT License, CI Status, and PRs Welcome badges to the top of the README.
  • Added a license section near the end of the README titled ## License
  • Added a contributing section linking to CONTRIBUTING.md under the title ## Contributing

Note for Maintainers

I noticed the acceptance criteria mentioned linking CODE_OF_CONDUCT.md and SECURITY.md but these files don't exist in the repo yet. I left those links out of the README for now so you can choose how you'd like to set up your security contact and community guidelines. Let me know if you'd like me to create stubs for them, or if this is good to merge as is!

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.

1 participant