README.md

In sailuh/kaiaulu: Kaiaulu

Kaiāulu

kai.ā.ulu n. 1. Community, neighborhood, village. ʻOia nō kekahi o nā kānaka waiwai nui a kūʻonoʻono ma iā mau kaiāulu, he was one of the wealthiest and most prosperous persons of these communities.

Overview

Kaiaulu is an R package and common interface that helps with understanding evolving software development communities, and the artifacts (gitlog, mailing list, files, etc.) which developers collaborate and communicate about. You can read more Kaiaulu's motivation and architecture in our paper's pre-print.

For detailed functionality, see Kaiaulu's API.

Please ask questions on Discussions or open an issue on the issue tracker if you found a bug, or your answer can't be found in the documentation. A more comprehensive and ever growing list of features is available on the Project Wiki.

Installation

Kaiaulu has been tested on OS X and Ubuntu. For Windows and other OS users, try Virtualbox, VMware, or any other software to run virtual machines for Ubuntu.

You can install Kaiaulu using the following command in your R console:

if (!require("devtools")) install.packages("devtools")
devtools::install_github("sailuh/kaiaulu")

I also recommend you download the repo to have some example project configuration files, and notebooks to experiment:

1. Clone this repo
2. Open kaiaulu.Rproj using RStudio
3. Run the unit tests devtools::test(). If any fail, and you are not clear why, feel free to ask in Discussions
4. Build the documentation devtools::document(roclets = c('rd', 'collate', 'namespace')).
5. Build Kaiaulu (Top right pane in RStudio -> Build tab -> Install and Restart)
6. Run vignettes/kaiaulu_architecture.Rmd
7. See the Wiki's Third Party Tools Setup if you are using a Notebook that relies on them. These require very minimal overhead by downloading a binary file and specifying their path on tools.yml (see example on the repository).

Getting started

To get started, browse through the docs.

Cheatsheets

| Social Smells | Architectural Flaws | | ------------- | ------------- | | | |

Stay up-to-date

• Read the NEWS file.

Contributing

• See the CONTRIBUTING file for contributing questions, issues and pull requests.

How to cite Kaiaulu

If you are using Kaiaulu in your research, please cite the following work:

@InProceedings{Paradis:2022,
author="Paradis, Carlos and Kazman, Rick",
editor="Scandurra, Patrizia and Galster, Matthias and Mirandola, Raffaela and Weyns, Danny",
title="Building the MSR Tool Kaiaulu: Design Principles and Experiences",
booktitle="Software Architecture",
year="2022",
publisher="Springer International Publishing",
address="Cham",
pages="107--129",
isbn="978-3-031-15116-3",
doi = "10.1007/978-3-031-15116-3_6"
}

For a list of previous work that used Kaiaulu, see vignettes/kaiaulu_case_studies.Rmd. If that's you, feel free to send a pull request modifying the Notebook with your work, and if possible, include a Bibtex record.

sailuh/kaiaulu documentation built on Dec. 10, 2024, 3:14 a.m.