COMCIFS / magnetic_dic

Development of the magnetic CIF dictionary
0 stars 4 forks source link

[RELEASE ISSUE] Checklist for first official release of cif_mag.dic #61

Open jamesrhester opened 7 months ago

jamesrhester commented 7 months ago

In concert with the next edition of Volume G I suggest we release v1.0.0 of cif_mag.dic. See here for an example of how this is done.

Outstanding pull requests/issues that should be resolved before releasing. Only easy or janitorial to go here. Please check any of your pet PRs or issues and add to the list below.

vaitkus commented 7 months ago

Ok, I added a few straightforward issues/PR that could be classified as janitorial. Feel free to cross-out those which seem out of scope. After these are resolved (or postponed) it would be nice to do one additional PR to fix any typos/formatting problems.

It would also be nice to resolve issue #48, however, it does require to first resolve a related issue in the Modulated Structures dictionary (see issue https://github.com/COMCIFS/Modulated_Structures/issues/14). Not sure if this is in scope for this release.

There are also issues #50 and #47 which required consultation/comments from software authors that might get affected by these changes, but I am not sure if those inquiries were made.

Finally, I am not sure is this is a blocking issue at all, but the Modulated Structures dictionary (https://github.com/COMCIFS/Modulated_Structures), which is imported in full by this dic, contains a few internal inconsistencies. It would be nice to resolve those first to make sure they do not mask any issues in this dictionary, but I do understand that this might not be a priority.

vaitkus commented 6 months ago

I added a few more per PRs of mine to the list, but almost all of them seem quite straightforward and easy to merge. Please remove if any of them seem irrelevant.