Skip to content

Conversation

@gpauloski
Copy link
Collaborator

Description

Refresh README with better overview, links, and badges.

Fixes

Type of Change

  • Breaking Change (fix or enhancement which changes existing semantics of the public interface)
  • Enhancement (new features or improvements to existing functionality)
  • Bug (fixes for a bug or issue)
  • Internal (refactoring, style changes, testing, optimizations)
  • Documentation update (changes to documentation or examples)
  • Package (dependencies, versions, package metadata)
  • Development (CI workflows, pre-commit, linters, templates)
  • Security (security related changes)

Testing

N/A

Pull Request Checklist

Please confirm the PR meets the following requirements.

  • Tags added to PR (e.g., breaking, bug, enhancement, internal, documentation, package, development, security).
  • Code changes pass pre-commit (e.g., mypy, ruff, etc.).
  • Tests have been added to show the fix is effective or that the new feature works.
  • New and existing unit tests pass locally with the changes.
  • Docs have been updated and reviewed if relevant.

@gpauloski gpauloski added the documentation Improvements or additions to documentation or examples label Jan 25, 2024
@gpauloski gpauloski merged commit 26c060b into main Jan 25, 2024
@gpauloski gpauloski deleted the issue-444 branch January 25, 2024 18:04
gpauloski added a commit that referenced this pull request Jan 25, 2024
@gpauloski gpauloski mentioned this pull request Jan 25, 2024
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation or examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refresh README and overview docs

2 participants