GitHub Actions - CI Updates #370
Merged
Conversation
This file contains 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
camisowers
requested changes
May 3, 2023
| @@ -244,7 +255,7 @@ The median pulse height (MPH) provides a way to assess the sensitivity of the de | |||
| 2. `cd` into `toffy`. | |||
| 3. Install the pre-commit hooks with `pre-commit install --install-hooks` | |||
| 4. Set up Poetry for `toffy` | |||
| 1. Run `poetry install` to install `alpineer` into your virtual environment (this will create a local virtual environment). | |||
| 1. Run `poetry install` to install `toffy` into your virtual environment (this will create a local virtual environment). | |||
There was a problem hiding this comment.
Can we add the Developer Notes link to the table of contents?
camisowers
reviewed
May 3, 2023
README.md
Outdated
| @@ -20,6 +32,9 @@ This repo is currently in beta testing. None of the code has been published yet, | |||
| - [Directory structure](#directory-structure) | |||
| - [Panel format](#panel-format) | |||
| - [Median Pulse Height](#median-pulse-height) | |||
| - [Development Notes](#development-notes) | |||
| - [Requirements](#requirements) | |||
| - [Setup](#setup) | |||
There was a problem hiding this comment.
This should probably be the same as requirements, a subheading under development notes right? If we want users to mainly use the conda environment probably best to make it clear Setup is only for developers.
ngreenwald
approved these changes
May 3, 2023
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.
If you haven't already, please read through our contributing guidelines before opening your PR
What is the purpose of this PR?
Closes #369.
How did you implement your changes
Used the workflows present in angelolab/alpineer. Also added package badges which state the tooling, PyPI info, supported Python Versions, etc...
Remaining issues
N/A.