Update release instructions #249
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
ngoldbaum
requested review from
robambalu,
AdamGlustein,
svatasoiu and
alexddobkin
as code owners
timkpaine
reviewed
May 23, 2024
timkpaine
reviewed
May 23, 2024
timkpaine
added
the
tag: internal
Signed-off-by: Nathan Goldbaum <[email protected]>
Signed-off-by: Tim Paine <[email protected]>
timkpaine
added
part: documentation
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.
This updates the release instructions in response to some feedback @robambalu shared after doing the 0.0.4 release and after #244.
It seems most of the maintainers at Point72 are directly pushing to the main repo, so I updated the instructions to match that common usage instead of the uncommon fork-based workflow that I originally assumed people would use. I've updated the note about how to deal with that to instead discuss how to deal with a fork and updated the main thread of the docs to talk about working with the main repo. I think that distinction was the main source of issues Rob ran into.
I also added some docs for conda-forge. Thankfully conda-forge is mostly automated so there's not much manual interaction besides merging bot-generated PRs, unless something breaks.