AI-SDC / ACRO

Tools for the Automatic Checking of Research Outputs. These are the tools for researchers to use as drop-in replacements for commands that produce outputs in Stata Python and R

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Define coding standards, and cI tests for e.g. Exception handling

jim-smith opened this issue · comments

Document setting out what our standards and processes have been

  • to help anyone coming new to work on the project
  • to assist in TRE IT departments/governance processes

Q: Is it sensible to add validation: run data through third party software e.g. Tau Argus or table builder to see what they flag as disclosive

Current status

  • The standards are held in the "contributing" section on the wiki
  • The current wiki mostly talks about about listing and formatting

Desired Effect

  • front page of repository (I.e. readme.md) points people to place in wiki
  • the wiki needs updating to talk about all code coming with appropriate tests to maintain 100% statement coverage
  • the wiki needs updating to talk about when we expect exception handling to be used