Updates to README and citation #5
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates the project version to 0.1.5 and enhances the README with installation instructions, CI badges, and improved citation guidance. It also adds CITATION.cff support to the version update script.
- Version bumped from 0.1.4 to 0.1.5 across all relevant files
- Added CITATION.cff file and integrated it into version management workflow
- Enhanced README with PyPI installation instructions, development setup options, and CI/CD badges
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/update_version.py | Added functions to read and update version in CITATION.cff, integrated citation version into consistency checks |
| pyproject.toml | Version bumped to 0.1.5 |
| hill_climber/init.py | Version bumped to 0.1.5 |
| README.md | Added CI badges, restructured installation section with PyPI and development setup instructions, updated Python requirement to 3.10+, improved license and citation sections, removed trailing slashes from documentation URLs |
| CITATION.cff | New citation metadata file for the repository |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
gperdrizet
had a problem deploying
to
test-pypi
GitHub Actions
Failure
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.