Add changelog #87 #158
Add changelog #87 #158
Conversation
There was a problem hiding this comment.
Is this where we will put things before they go onto version release notes? Maybe we just work with version release notes file (numpy is a much larger project so they need to announce changes)
There was a problem hiding this comment.
Move to release notes file - for simplicity
There was a problem hiding this comment.
@XingerTang minor comments. This looks fantastic otherwise. I wonder if it’s almost too much, but time will tell! I like it. Now we just need to ensure we build it gradually with each PR!
|
@XingerTang I lost track on this PR too. Should we merge in and work from this point onwards? |
|
@gregorgorjanc I think it might be because the changes are still ongoing so we can't finish it until all the changes have completed. |
|
@XingerTang I am thinking that we should be growing changelog with each new major PR/change so that we don't have these multiple PR open and wondering what needs doing in each one. What are the major things that we are currently working on? Please list these in the changelog as work in progress and then we merge this in, and update the changelog when those work in progress PR/changes are merged into the devel branch. |
|
#87 #154
Adapted from numpy's changelog, upcoming changes, and release notes.
The reason for using the templates and structures from Numpy instead of msprime is that Numpy also builds the documentation using Sphinx, while msprime builds the documentation in its own way. So Numpy is using
.rstfiles while msprime is using.mdfile. As we are using.rstand Sphinx now, I think it is better to follow what Numpy did.The preview for the release notes page of the updated documentation is available at https://xingertang-alphapeel.readthedocs.io/en/latest/release/1.2.0-notes.html.
As Numpy did not put changelog and upcoming changes inside its documentation, I also didn't add it, but we can change it if necessary.