-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Version 0.2.0 Release #146
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #146 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 8 8
Lines 351 351
Branches 50 50
=========================================
Hits 351 351 ☔ View full report in Codecov by Sentry. |
@jeromekelleher Would it be possible for you to check the changelog for me? If it looks good, I will update the date of the version 0.2.0 in this document, and I hope that we can release the new version soon. |
e88bf82
to
7911c41
Compare
Sorry, it is version 0.1.0, not 0.2.0. However, I think we can actually make the new release as version 1.0.0, as we had validated the proporties of tstrait, many new functionalities are added to implement the simulation frameworks of other external simulators, and I feel that this is the complete package now. Do you have any thoughts on this? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. I don't think listing out the URLs is an improvement, and you need to be a bit clearer about the breaking status.
I think version 1.0.0 is quite premature (consider how many versions msprime went through before 1.0)
CHANGELOG.md
Outdated
|
||
### Documentation: | ||
|
||
- Create infrastructure for documentation {pr}`77` | ||
- Build initial documentation {pr}`78` | ||
- Add Changelog to documentation {pr}`79` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are you replacing these? the {pr}73
should get interpreted by jupyter book and substituted correctly. If not, the jupyterbook config needs some tweaking
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I looked up the tstrait website, and it seems that {pr} is working, so I modified it just now.
CHANGELOG.md
Outdated
|
||
### Contributors: | ||
|
||
- Jerome Kelleher |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Order these alphabetically?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GitHub will do this anyway, so there's no need to list out the contributors I think (unless you want to)
## [0.1.0] - 2024-03-XX | ||
|
||
### Changes from Version 0.0.1: | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you need to make it clearer that this is a breaking change release. What code written using the 0.0.1 version would now break, and what should users do about it?
7911c41
to
a3e14ae
Compare
I fixed it now, so would it be possible for you to check it again @jeromekelleher ? |
Update the changelog for version0.1.0 release
a3e14ae
to
33cf5e9
Compare
Update the changelog for version0.2.0 release