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

Precommit fixes and basic readme #17

Merged
merged 2 commits into from
Dec 10, 2024
Merged

Precommit fixes and basic readme #17

merged 2 commits into from
Dec 10, 2024

Conversation

sfmig
Copy link
Contributor

@sfmig sfmig commented Dec 10, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?
Installation of the package from source as described in the README was failing due to a typo in the tags.

What does this PR do?

  • The typo in the tags has been fixed and the pre-commits applied (so the tests now pass).
  • I added a simple README specifying installation instructions.

References

#2

How has this PR been tested?

\

Is this a breaking change?

\

Does this PR require an update to the documentation?

\

Checklist:

  • The code has been tested locally
  • [ n/a ] Tests have been added to cover all new functionality
  • [ n/a ] The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@sfmig sfmig changed the title Precommit fixes Precommit fixes and basic readme Dec 10, 2024
@sfmig sfmig marked this pull request as ready for review December 10, 2024 15:14
@sfmig sfmig merged commit 9425135 into main Dec 10, 2024
9 checks passed
@sfmig sfmig deleted the smg/fix-tag-version-error branch December 10, 2024 15:14
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