Minor updates post OSS #131
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
ppinchuk
added
chore
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds citation metadata (DOI) and a Zenodo badge, introduces an automated documentation build/deploy GitHub Actions workflow, and removes a stale commented line in code.
- Add Zenodo DOI badge to README and DOI metadata to CITATION.cff
- Introduce docs build & deploy workflow (GitHub Pages) on pushes/releases
- Minor cleanup: remove obsolete commented line in dry_costs_creator.py
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| revrt/costs/dry_costs_creator.py | Removes an unused commented-out assignment (minor cleanup). |
| README.rst | Adds Zenodo badge; documentation metadata update only. |
| CITATION.cff | Adds active DOI identifier block. |
| .github/workflows/docs.yml | New workflow to build and publish documentation to gh-pages. |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
castelao
approved these changes
Sep 22, 2025
Member
castelao
left a comment
castelao
left a comment
There was a problem hiding this comment.
LGTM. In the CITATION we can add references to some of the other software that we use, but I can add later in another PR.
Collaborator
Author
That'd be great! Do we need to open an issue to track this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add DOI badge and docs GHA