[Paullo9]

Requested by Paul · project thread

Before

The repository had no citation file, no contributing guide, no security policy, and no issue or pull request templates. The Swift Package Index config (.spi.yml) still said the MRC and EMPAD modules were empty and left out of the hosted docs, and it did not mention the Merlin MIB module. All three modules now hold readers.

After

Visitors can see how to cite the package, how to build and test it, what the tests promise (bit for bit against RosettaSciIO), and how to report a bug or a vulnerability privately. Bug and feature forms and a PR checklist are in place. The hosted docs list now includes FormatoMRC, FormatoEMPAD and FormatoMIB. FormatoMSA stays out because it is still an empty placeholder (5-line source file).

How

Only new files were added, plus .spi.yml. Nothing under Sources, Tests, tools or Package.swift was touched, and README, CHANGELOG, NOTICE and docs/status.md were left alone to avoid conflicts with the unreleased 0.4.0 work. The .spi.yml claims were checked against Package.swift and the Sources folders.

Files: CITATION.cff, CONTRIBUTING.md, SECURITY.md, .github/ISSUE_TEMPLATE/bug_report.yml, .github/ISSUE_TEMPLATE/feature_request.yml, .github/pull_request_template.md, .spi.yml.

Things to check:

• CITATION.cff uses the placeholder author mac4DSTEM contributors. Please set real author names.
• The licence in CITATION.cff is GPL-3.0-or-later, as requested. README only says "GPL-3.0" and LICENSE is the v3 text, so confirm "or later" is intended.
• SECURITY.md assumes private vulnerability reporting is enabled in the repository settings.
• Neither CONTRIBUTING.md nor .github/pull_request_template.md says which Swift version or macOS the CI uses.

Left for the owner's Mac

• README.md line 126: "FormatoMRC/EMPAD/MSA" is listed as pure Swift for iOS, but MSA is an empty placeholder.
• README.md lines 142-145: the build section uses internal jargon ("the gate", "last-green stamp", "121 inherited test names", "break-once proof"). A plain swift test line would be clearer for outsiders.
• README.md line 151: the section points at docs/registration-step-1.md, an internal document.
• README.md line 134 area: state whether the licence is GPL-3.0-only or or-later.
• CHANGELOG.md, NOTICE and docs/status.md: not reviewed, to avoid conflicts.
• CI comments in .github/workflows/ci.yml: they mention internal steps and owner actions ("enabling Actions is the owner's", the 121 names). They were not edited, to keep the workflow untouched.

Proposed separately

• CLAUDE.md, AGENTS.md and .claude/ are internal session instructions. Consider keeping them out of the public tree, or moving them to a private location, once the local sessions no longer need them.
• docs/registration-*, docs/consumers-* and docs/status.md are internal process records. Consider moving them to an archive, or keeping them if you want the history public.
• Enable GitHub private vulnerability reporting in the repository settings so SECURITY.md works.

---

Generated by Claude Code