Skip to content

Commit 9e7e2ae

Browse files
committed
docs: implemented feedback by chtinnes
1 parent 0f35c0f commit 9e7e2ae

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

STATUS.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
## Overview
33
The artifact for the paper _Classifying Edits to Variability in Source Code_ consists of four parts:
44

5-
1. **DiffDetective**: For our validation, we built DiffDetective, a java library and command-line tool to classify edits to variability in git histories of preprocessor-based software product lines. DiffDetective is the main artifact used to replicate the validation for our paper (see Section 5).
5+
1. **DiffDetective**: For our validation, we built DiffDetective, a java library and command-line tool to classify edits to variability in git histories of preprocessor-based software product lines.
6+
DiffDetective is the main artifact used to replicate the validation for our paper (see Section 5).
7+
DiffDetective is self-contained in that it does not require or depend on in-depth knowledge on the theoretical foundation of our work.
8+
Practitioners and researches are free to ignore the appendix as well as the haskell formalization and may use DiffDetective out-of-the-box.
69
2. **Appendix**: The appendix of our paper is given in PDF format in the file [`appendix.pdf`][ddappendix].
710
3. **Haskell Formalization**: We provide an extended formalization in the Haskell programming language as described in our appendix. Its implementation can be found in the Haskell project in the [`proofs`][ddproofs] directory.
811
4. **Dataset Overview**: We provide an overview of the 44 inspected open-source software product lines with updated links to their repositories in the file [docs/datasets.md][dddatasets].
@@ -11,7 +14,8 @@ The artifact for the paper _Classifying Edits to Variability in Source Code_ con
1114
Our artifact has the following purposes:
1215

1316
### **Replicability**
14-
We provide replication instructions that allow to replicate the validation we performed in Section 5 of our paper. The replication is executed in a Docker container. To replicate our results, we also provide [forks of all 44 datasets][ddforks] in the very state we performed our validation on.
17+
We provide replication instructions that allow to replicate the validation we performed in Section 5 of our paper.
18+
The replication is executed in a Docker container. To replicate our results, we also provide [forks of all 44 datasets][ddforks] in the very state we performed our validation on.
1519

1620
### **Reusability**
1721
DiffDetective is designed as a library that offers reusable functionality.
@@ -24,8 +28,8 @@ parsing variation tree diffs from unix diffs, obtaining variation tree diffs for
2428
The [`proofs`][ddproofs] Haskell project provides an extended formal specification of our theory.
2529
Its main purpose is to document the theory and its extensions to serve as a reference for the proofs in our appendix.
2630
Yet, the project can also be used as a library to reason on variation trees and diffs in Haskell projects.
27-
2831
The library is accompanied by a small demo application that shows an example test case for our proof of completeness by creating a variation tree diff from two variation trees and re-projecting them.
32+
The `proofs` project is described in detail in our appendix.
2933

3034
## Claims
3135
We claim the _Artifacts Available_ badge as we made our artefacts publicly available on [Github][ddgithub] and [Zenodo][ddzenodo] with an [open-source license][ddlicense].
@@ -40,4 +44,4 @@ Furthermore, both DiffDetective and our Haskell formalization serve as reference
4044
[ddlicense]: https://github.com/VariantSync/DiffDetective/blob/main/LICENSE.LGPL3
4145
[dddatasets]: docs/datasets.md
4246
[ddforks]: docs/replication/datasets.md
43-
[dddocumentation]: https://variantsync.github.io/DiffDetective/docs/javadoc/
47+
[dddocumentation]: https://variantsync.github.io/DiffDetective/docs/javadoc/

0 commit comments

Comments
 (0)