講演抄録/キーワード |
講演名 |
2020-03-04 13:25
OSSプロジェクトにおけるREADME.mdファイルの作成の支援 ○清水一輝・亀井靖高・佐藤亮介・鵜林尚靖(九大) SS2019-42 |
抄録 |
(和) |
GitHub といったホスティングサービスで公開されている OSS 開発プロジェクトにおいて,README.md ファイルはプロジェクトの初印象を決定する大きな役割を持っている.そのため README.md は新規参入の手助けと なったりプロジェクトの維持に影響を与える.OSS 開発プロジェクトへの関心は近年高まっているが,README.md に書くべき内容や文章量といった README.md そのものに関する研究はほとんど存在しない.本研究は README.md を作成するための指標となるような2つの調査課題(RQ1)プロジェクトの規模と README.md の文章量との相関は あるのか,(RQ2)README.md を作成する上で重要な単語は何か,に回答する.上記の RQ について調査することに より,リポジトリのソースコードファイルの行数から決定係数 0.32 の全.md ファイルの文章量を予測できる回帰直線が 得られ,「いつ」を表す単語として status など,いくつかのカテゴリにおいてそのカテゴリを代表するような単語を得る ことができた. |
(英) |
In the OSS development projects published on hosting service such as GitHub, README.md files are used to get an overview of a project. README.md files are written to help new developers get involved with a project and to document information relevant to the project’s maintenance. Interest and research for OSS develop- ment projects has increased in recent years, but there is little research on README.md files themselves, such as the content to be written in README.md files or their size. The purpose of this research is to understand indicators to make README.md files by answering the following RQs. (RQ1)Is there a correlation between the size of the project and the amount of text in README.md files? (RQ2)What are the important words to include when making a README.md file? While investigating the above RQs, we used a regression line to predicts the size of all .md files based on source code lines, from this linear regression analysis, we obtained a 0.32 coefficient determination. For the second part of our study, we were able to detect defining words for specific sections of README.md files. For example, in sections titled "status", we found that the word "When" is often used to describe the purpose of the project status. |
キーワード |
(和) |
OSS / GitHub / README.md / / / / / |
(英) |
OSS / GitHub / README.md / / / / / |
文献情報 |
信学技報, vol. 119, no. 451, SS2019-42, pp. 7-12, 2020年3月. |
資料番号 |
SS2019-42 |
発行日 |
2020-02-26 (SS) |
ISSN |
Online edition: ISSN 2432-6380 |
著作権に ついて |
技術研究報告に掲載された論文の著作権は電子情報通信学会に帰属します.(許諾番号:10GA0019/12GB0052/13GB0056/17GB0034/18GB0034) |
PDFダウンロード |
SS2019-42 |
研究会情報 |
研究会 |
SS |
開催期間 |
2020-03-04 - 2020-03-05 |
開催地(和) |
てんぶす那覇 |
開催地(英) |
|
テーマ(和) |
一般 |
テーマ(英) |
|
講演論文情報の詳細 |
申込み研究会 |
SS |
会議コード |
2020-03-SS |
本文の言語 |
日本語 |
タイトル(和) |
OSSプロジェクトにおけるREADME.mdファイルの作成の支援 |
サブタイトル(和) |
|
タイトル(英) |
Supporting OSS Developers to Make and Maintain README.md Files in OSS Projects |
サブタイトル(英) |
|
キーワード(1)(和/英) |
OSS / OSS |
キーワード(2)(和/英) |
GitHub / GitHub |
キーワード(3)(和/英) |
README.md / README.md |
キーワード(4)(和/英) |
/ |
キーワード(5)(和/英) |
/ |
キーワード(6)(和/英) |
/ |
キーワード(7)(和/英) |
/ |
キーワード(8)(和/英) |
/ |
第1著者 氏名(和/英/ヨミ) |
清水 一輝 / Kazuki Shimizu / シミズ カズキ |
第1著者 所属(和/英) |
九州大学 (略称: 九大)
Kyushu University (略称: Kyushu Univ.) |
第2著者 氏名(和/英/ヨミ) |
亀井 靖高 / Yasutaka Kamei / カメイ ヤスタカ |
第2著者 所属(和/英) |
九州大学 (略称: 九大)
Kyushu University (略称: Kyushu Univ.) |
第3著者 氏名(和/英/ヨミ) |
佐藤 亮介 / Ryosuke Sato / サトウ リョウスケ |
第3著者 所属(和/英) |
九州大学 (略称: 九大)
Kyushu University (略称: Kyushu Univ.) |
第4著者 氏名(和/英/ヨミ) |
鵜林 尚靖 / Naoyasu Ubayashi / ウバヤシ ナオヤス |
第4著者 所属(和/英) |
九州大学 (略称: 九大)
Kyushu University (略称: Kyushu Univ.) |
第5著者 氏名(和/英/ヨミ) |
/ / |
第5著者 所属(和/英) |
(略称: )
(略称: ) |
第6著者 氏名(和/英/ヨミ) |
/ / |
第6著者 所属(和/英) |
(略称: )
(略称: ) |
第7著者 氏名(和/英/ヨミ) |
/ / |
第7著者 所属(和/英) |
(略称: )
(略称: ) |
第8著者 氏名(和/英/ヨミ) |
/ / |
第8著者 所属(和/英) |
(略称: )
(略称: ) |
第9著者 氏名(和/英/ヨミ) |
/ / |
第9著者 所属(和/英) |
(略称: )
(略称: ) |
第10著者 氏名(和/英/ヨミ) |
/ / |
第10著者 所属(和/英) |
(略称: )
(略称: ) |
第11著者 氏名(和/英/ヨミ) |
/ / |
第11著者 所属(和/英) |
(略称: )
(略称: ) |
第12著者 氏名(和/英/ヨミ) |
/ / |
第12著者 所属(和/英) |
(略称: )
(略称: ) |
第13著者 氏名(和/英/ヨミ) |
/ / |
第13著者 所属(和/英) |
(略称: )
(略称: ) |
第14著者 氏名(和/英/ヨミ) |
/ / |
第14著者 所属(和/英) |
(略称: )
(略称: ) |
第15著者 氏名(和/英/ヨミ) |
/ / |
第15著者 所属(和/英) |
(略称: )
(略称: ) |
第16著者 氏名(和/英/ヨミ) |
/ / |
第16著者 所属(和/英) |
(略称: )
(略称: ) |
第17著者 氏名(和/英/ヨミ) |
/ / |
第17著者 所属(和/英) |
(略称: )
(略称: ) |
第18著者 氏名(和/英/ヨミ) |
/ / |
第18著者 所属(和/英) |
(略称: )
(略称: ) |
第19著者 氏名(和/英/ヨミ) |
/ / |
第19著者 所属(和/英) |
(略称: )
(略称: ) |
第20著者 氏名(和/英/ヨミ) |
/ / |
第20著者 所属(和/英) |
(略称: )
(略称: ) |
講演者 |
第1著者 |
発表日時 |
2020-03-04 13:25:00 |
発表時間 |
25分 |
申込先研究会 |
SS |
資料番号 |
SS2019-42 |
巻番号(vol) |
vol.119 |
号番号(no) |
no.451 |
ページ範囲 |
pp.7-12 |
ページ数 |
6 |
発行日 |
2020-02-26 (SS) |