Skip to content
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 first official release of cif_mag.dic #61

Open
11 tasks
jamesrhester opened this issue Jan 19, 2024 · 2 comments
Open
11 tasks

Comments

@jamesrhester
Copy link
Contributor

jamesrhester commented Jan 19, 2024

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.

  • Release manager appointed
  • _dictionary_audit.revision comments summarised
  • Release branch created
  • Next version placeholder created in dictionary_audit section in main branch
  • Plain text summary of changes created
  • COMCIFS advised of any COMCIFS-significant updates (e.g. changes in units)
  • Magnetic Structures Commission advised
  • All comments during review period addressed (add to list below)
  • Final DOI and URL edited into file (IUCr Chester office to advise of DOI)
  • Github release tagged
  • IUCr updated with released file

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
Copy link
Collaborator

vaitkus commented Jan 19, 2024

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 COMCIFS/Modulated_Structures#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
Copy link
Collaborator

vaitkus commented Feb 7, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants