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

Update README.md - add Docs badge and link License badge to license file #21

Merged
merged 2 commits into from
Jun 5, 2024

Conversation

kdpsingh
Copy link
Contributor

@kdpsingh kdpsingh commented Jun 5, 2024

Overview

  • The documentation is linked at the top-right of the repository page but not within the README itself
  • The License badge, when clicked, points to the image of the badge rather than the text of the license

Description of changes

  • Adds a documentation badge to the front of the README to make it easy to find
  • Points the License badge to the License.txt file within the repository

Author Checklist

  • Happy to update the changelog but since the changes only affect the README, not sure if needed

  • [N/A] Linting passes; run early with pre-commit hook.

  • [N/A] Tests added for new code and issue being fixed.

  • [N/A] Added type annotations and full numpy-style docstrings for new methods.

  • [Needed?] Draft your news fragment in new changelog/ISSUE.TYPE.rst files; see changelog/README.md.

@diehlbw diehlbw added the skip changelog Add to allow skipping creation of a changelog entry label Jun 5, 2024
README.md Show resolved Hide resolved
@diehlbw
Copy link
Collaborator

diehlbw commented Jun 5, 2024

Also, don't worry about the changelog check failing. That is my fault, and an issue I'll write up.
Currently, labels only seem to be checked at time of commit so it isn't skipping that properly.

I agree this shouldn't necessitate that update

@CLAassistant
Copy link

CLAassistant commented Jun 5, 2024

CLA assistant check
All committers have signed the CLA.

@diehlbw diehlbw merged commit d327b7f into epic-open-source:main Jun 5, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changelog Add to allow skipping creation of a changelog entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants