IEICE Technical Committee Submission System
Conference Paper's Information
Online Proceedings
[Sign in]
Tech. Rep. Archives
 Go Top Page Go Previous   [Japanese] / [English] 

Paper Abstract and Keywords
Presentation 2020-03-04 13:25
Supporting OSS Developers to Make and Maintain README.md Files in OSS Projects
Kazuki Shimizu, Yasutaka Kamei, Ryosuke Sato, Naoyasu Ubayashi (Kyushu Univ.) SS2019-42
Abstract (in Japanese) (See Japanese page) 
(in English) 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.
Keyword (in Japanese) (See Japanese page) 
(in English) OSS / GitHub / README.md / / / / /  
Reference Info. IEICE Tech. Rep., vol. 119, no. 451, SS2019-42, pp. 7-12, March 2020.
Paper # SS2019-42 
Date of Issue 2020-02-26 (SS) 
ISSN Print edition: ISSN 0913-5685  Online edition: ISSN 2432-6380
Copyright
and
reproduction
All rights are reserved and no part of this publication may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopy, recording, or any information storage and retrieval system, without permission in writing from the publisher. Notwithstanding, instructors are permitted to photocopy isolated articles for noncommercial classroom use without fee. (License No.: 10GA0019/12GB0052/13GB0056/17GB0034/18GB0034)
Download PDF SS2019-42

Conference Information
Committee SS  
Conference Date 2020-03-04 - 2020-03-05 
Place (in Japanese) (See Japanese page) 
Place (in English)  
Topics (in Japanese) (See Japanese page) 
Topics (in English)  
Paper Information
Registration To SS 
Conference Code 2020-03-SS 
Language Japanese 
Title (in Japanese) (See Japanese page) 
Sub Title (in Japanese) (See Japanese page) 
Title (in English) Supporting OSS Developers to Make and Maintain README.md Files in OSS Projects 
Sub Title (in English)  
Keyword(1) OSS  
Keyword(2) GitHub  
Keyword(3) README.md  
Keyword(4)  
Keyword(5)  
Keyword(6)  
Keyword(7)  
Keyword(8)  
1st Author's Name Kazuki Shimizu  
1st Author's Affiliation Kyushu University (Kyushu Univ.)
2nd Author's Name Yasutaka Kamei  
2nd Author's Affiliation Kyushu University (Kyushu Univ.)
3rd Author's Name Ryosuke Sato  
3rd Author's Affiliation Kyushu University (Kyushu Univ.)
4th Author's Name Naoyasu Ubayashi  
4th Author's Affiliation Kyushu University (Kyushu Univ.)
5th Author's Name  
5th Author's Affiliation ()
6th Author's Name  
6th Author's Affiliation ()
7th Author's Name  
7th Author's Affiliation ()
8th Author's Name  
8th Author's Affiliation ()
9th Author's Name  
9th Author's Affiliation ()
10th Author's Name  
10th Author's Affiliation ()
11th Author's Name  
11th Author's Affiliation ()
12th Author's Name  
12th Author's Affiliation ()
13th Author's Name  
13th Author's Affiliation ()
14th Author's Name  
14th Author's Affiliation ()
15th Author's Name  
15th Author's Affiliation ()
16th Author's Name  
16th Author's Affiliation ()
17th Author's Name  
17th Author's Affiliation ()
18th Author's Name  
18th Author's Affiliation ()
19th Author's Name  
19th Author's Affiliation ()
20th Author's Name  
20th Author's Affiliation ()
Speaker
Date Time 2020-03-04 13:25:00 
Presentation Time 25 
Registration for SS 
Paper # IEICE-SS2019-42 
Volume (vol) IEICE-119 
Number (no) no.451 
Page pp.7-12 
#Pages IEICE-6 
Date of Issue IEICE-SS-2020-02-26 


[Return to Top Page]

[Return to IEICE Web Page]


The Institute of Electronics, Information and Communication Engineers (IEICE), Japan