Replication Kit - What the Fix? A Study of ASATs Rule Documentation

Contains all artefacts for our publication: What the Fix? A Study of ASATs Rule Documentation @ ICPC 2024Content survey: Archive from LimeSurvey, rules annotated used and raw results taxonomy_validation: Rules annotated by the authors to validate the taxonomy and notebook computing kappa values website: Build of the companion webpage (currently hosted at https://icpc2024-asats.github.io) Paper abstractAutomatic Static Analysis Tools (ASATs) are widely used by software developers to diffuse and enforce coding practices. Yet, we know little about the documentation of ASATs, despite it being critical to learn about the coding practices in the first place. We shed light on this through a two-phase study. First, we analyze the documentation of more than 100 rules of 16 ASATs for multiple programming languages, and distill a taxonomy of the goals of the documentation and its types of contents. Then, we conduct a survey to assess the effectiveness of the documentation in terms of its goals and types of contents. We highlight opportunities for improvement in ASAT documentation.本数据集包含我们发表于国际代码大会2024（ICPC 2024）的论文《What the Fix? A Study of Automatic Static Analysis Tools (ASATs) Rule Documentation》相关的全部研究制品。 - 调查问卷：源自LimeSurvey的存档文件、已标注的规则使用记录与原始调研结果 - 分类学验证：由作者标注的、用于验证分类学框架的规则集，以及用于计算Kappa系数的计算笔记本 - 配套网站：本研究配套网页的源码构建产物（当前托管于https://icpc2024-asats.github.io） 【论文摘要】自动静态分析工具（Automatic Static Analysis Tools, ASATs）被软件开发人员广泛用于推广并强制执行编码规范。然而，尽管编码规范文档本身是理解编码实践的核心依据，但目前学界对ASATs文档的相关研究仍较为匮乏。本研究通过两阶段实验展开探索：第一阶段，我们针对16款支持多种编程语言的ASATs的100余条规则文档进行分析，提炼出ASATs文档的目标分类体系与内容类型框架；第二阶段，我们开展调查问卷以评估ASATs文档在实现其预设目标与覆盖各类内容维度上的有效性。最终，我们总结出ASATs文档的多项优化方向。