Add release notes for 0.1.0 #647
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
change description for general release
allyhawkins
approved these changes
Jul 23, 2024
CHANGELOG.md
Outdated
|
|
||
| With respect to infrastructure, the repository contains the following components: | ||
|
|
||
| - detailed documentation in the `docs` directory explaining how to interact with the OpenScPCA project and how to set up and run analyses |
There was a problem hiding this comment.
Maybe provide a link to the actual docs too?
RELEASE_NOTES.md
Outdated
There was a problem hiding this comment.
Why do we also have this file? What am I missing?
There was a problem hiding this comment.
I had named it that before. Not sure how it got duplicated rather than renamed!
|
Okay, I removed the extra file, added the link @allyhawkins requested, and then decided that we should probably keep these root-level *I run |
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.
As I was preparing #623, I thought it might be nice to have the release notes reviewed, which let me to wanting to create a changelog file to hold them all.
Please review these initial release notes, and let me know if there is anything you think I should specifically add or generally rephrase.
I also made a few updates fixing paths in templates that I noticed had changed and a few other minor template updates.