Skip to content

Document artdaq SQA development procedures and references#295

Open
Copilot wants to merge 3 commits into
developfrom
copilot/document-development-procedures-sqa
Open

Document artdaq SQA development procedures and references#295
Copilot wants to merge 3 commits into
developfrom
copilot/document-development-procedures-sqa

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 7, 2026

artdaq needs explicit SQA-facing documentation describing how the project is designed, developed, and maintained, aligned with lab SQA expectations. This PR adds that guidance at the top-level project entry point and links to the canonical process resources.

  • README: add SQA policy section

    • Introduces a new Software quality assurance (SQA) section in README.md.
    • States that artdaq follows documented procedures for design, development, review, testing, and maintenance.
  • Authoritative references

    • Adds direct links to:
      • the artdaq Wiki (project-maintained process/documentation surface),
      • Fermilab Software QA working documents (SharePoint source referenced in the issue).
  • Alignment with upstream art documentation

    • Captures the expectation to review/adopt emerging art SQA materials where applicable and keep artdaq references current.
## Software quality assurance (SQA)

_artdaq_ is maintained under the lab software quality assurance program and follows documented procedures for how software is designed, developed, reviewed, tested, and maintained.

For SQA process details, see:

* [artdaq Wiki](https://github.com/art-daq/artdaq/wiki)
* [Fermilab Software QA working documents (SharePoint)](https://fermipoint.fnal.gov/organization/cs/ocio/opm/QA/SoftwareQA/WorkingDocuments/Shared%20Documents/Forms/AllItems.aspx)

Copilot AI linked an issue May 7, 2026 that may be closed by this pull request
Agent-Logs-Url: https://github.com/art-daq/artdaq/sessions/229fad03-9ec8-4227-8cf7-7dda0b8adf0e

Co-authored-by: eflumerf <61473357+eflumerf@users.noreply.github.com>
Copilot AI changed the title [WIP] Add development procedures documentation for SQA Document artdaq SQA development procedures and references May 7, 2026
Copilot AI requested a review from eflumerf May 7, 2026 14:00
@eflumerf eflumerf marked this pull request as ready for review May 7, 2026 18:48
@eflumerf eflumerf requested a review from ron003 May 7, 2026 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 📋 Triage

Development

Successfully merging this pull request may close these issues.

Document development procedures for SQA

3 participants