-
Notifications
You must be signed in to change notification settings - Fork 9
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
[RELEASE ISSUE]: Checklist for next release of cif_core #317
Comments
Release manager is @jamesrhester this time. |
One question regarding the summarisation of |
What I planned to do is summarise the comments within each My thinking is that the dictionary audit information doesn't have to have details of all bug fixes, minor typo corrections and so on, these can just be described as "bug and typo fixes". The nature of each change will be available in the git history. More important to keep are things like new categories being added. |
I have created an initial set of release notes in the wiki here. Please look over them and add anything you think is missing, bearing in mind that we don't want them to be so long that we lose the attention of busy software authors. @rowlesmr would you mind writing up the section on elemental composition? You could include a link to the example contained in the file. |
I've added some words and links. |
Excellent! |
I've confirmed with the IUCr Chester office that they will create a DOI for us using CrossRef, and the form of the DOI will be known ahead of time so that we can edit it in. It will also refer to the actual file, rather than a landing page. |
I've been asked today "Why not distribute a single dictionary file?" - i.e. expanded version including imports. Any thoughts on this? |
Well the original thinking was that having imported files ( So we would end up with the source repository containing the separate files, and the IUCr distribution point containing the combined files? I guess that could work, as those wishing to just read the dictionaries in whatever form do not need to fiddle with auxiliary files. Sort of like a compiled version of software. |
Would this also be extended to cases where dictionaries import other dictionaries? |
That would definitely be impractical and repetitive. |
I've now placed the release files on Github and can say we have finally finished the 3.2.0 release. |
Thank you for the work! |
This is a first attempt at a release checklist. We do have some things unresolved, but we'll try and deal with those as they arise. I can be release manager this time as we iron out the problems, hopefully we can rotate around.
_dictionary_audit.revision
comments summarisedOutstanding pull requests/ issues that should be resolved before releasing. Only the very easy ones go here, e.g. 'janitorial'. Please check any issues you have raised and see if they could be resolved easily or have already been resolved.
version
content type follows the syntax of SemVer 2.0 #312The text was updated successfully, but these errors were encountered: