add dataset note

This commit is contained in:
whystar 2020-08-26 18:44:04 +08:00
parent 796c685ecf
commit f4526bac05
4 changed files with 33 additions and 9 deletions

View File

@ -16,7 +16,7 @@ which can help project maintainers to \textit{``grow their community and support
GitHub,
which attracts more than 40 million of developers~\cite{github},
has been the most popular platform for community-based OSS development
because of its social coding support~\cite{Dabbish2012Social} and pull-based collaborating mechanism~\cite{Zhu2016Effe,jiang2017and}.
because of its social coding support~\cite{Dabbish2012Social,storey2016social} and pull-based collaborating mechanism~\cite{Zhu2016Effe,jiang2017and}.
In GitHub specifically,
project maintainers can include five main kinds of community profile documentation.
When users create a new repository,
@ -65,7 +65,7 @@ Our findings present a quantitative insights into and achieve a better understan
The main contributions of the paper are as follows:
\begin{itemize}
\item Constructing a large scale of dataset of community profile documentation collected from 2,000 OSS projects randomly sampled from GitHub,
\item Constructing a large scale of dataset~\footnote{The dataset will be made public upon acceptance of the paper.} of community profile documentation collected from 2,000 OSS projects randomly sampled from GitHub,
which can be used in future research for other intentions.
\item Presenting the prevalence of community profile documentation from multiple perspectives,
which can help OSS contributors make more informed choices

View File

@ -164,7 +164,8 @@ by going through the three directories (\ie \textit{root}, \textit{docs}, and \t
\subsubsection{Change history of documentation}
To obtain the change history of a specific file in a project,
a common way is to clone the remote repository into a local machine, and then use \texttt{git} commands (\eg \texttt{git log [file\_name]} and \texttt{git show [commit\_sha]}) to obtain the list of historical changes (\ie code commits) on the file.
a common way is to clone the remote repository into a local machine~\cite{2018Adding,Vendome2017License},
and then use \texttt{git} commands (\eg \texttt{git log [file\_name]} and \texttt{git show [commit\_sha]}) to obtain the list of historical changes (\ie code commits) on the file.
However,
it is a time-consuming and storage-intensive method.
Instead,
@ -173,6 +174,6 @@ The input of the tool is a URL (https://github.com/[repository\_slug]/co\-mmits/
which varies by changing the repository name, default branch, and file name.
From the pages,
the tool identified a list of changes,
from each of the which,
from each of which,
it extracted the change author, the change time,
and the change summary(\ie commit message).

View File

@ -47,8 +47,8 @@ At last,
we note that \COD documentation has an extremely low percentage of inclusion,
\ie only 10.95\% of projects include a \COD file.
This might be due to the viewpoint that
OSS developers are mature enough to behave well and deal with debates and differences,
and therefore it is not necessary to include a \COD file~\cite{Tourani2017Code}.
OSS developers are mature enough to behave well and deal with debates and differences~\cite{Tourani2017Code},
and therefore it is not necessary to include a \COD file.
@ -138,7 +138,7 @@ In GitHub,
the owner of a repository can be an \textit{organization} account or a \textit{user} account~\cite{Coelho2017Why,Jiang2017Understanding}.
Personal user accounts are usually intended for individual developers,
while organization accounts are intended for companies and non-profit organizations~\cite{Jiang2017Understanding}
which act as shared accounts to make it more convenient for people to collaborate across many projects at once~\footnote{\url{https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-organizations}}.
which act as shared accounts to make it more convenient for people to collaborate across many projects at once~\cite{org}.
% 阐述数据

View File

@ -8,6 +8,18 @@
}
@article{storey2016social,
title={How social and communication channels shape and challenge a participatory culture in software development},
author={Storey, Margaret-Anne and Zagalsky, Alexey and Figueira Filho, Fernando and Singer, Leif and German, Daniel M},
journal={IEEE Transactions on Software Engineering},
volume={43},
number={2},
pages={185--204},
year={2016},
publisher={IEEE}
}
@article{jiang2017and,
title={Why and how developers fork what from whom in GitHub},
author={Jiang, Jing and Lo, David and He, Jiahuan and Xia, Xin and Kochhar, Pavneet Singh and Zhang, Li},
@ -55,17 +67,28 @@
}
@Misc{org,
howpublished = {\url{https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-organizations
}},
note = {Accessed: 2020-08-28},
title = {About organizations},
}
@Misc{template,
howpublished = {\url{https://docs.github.com/en/github/building-a-strong-community/about-issue-and-pull-request-templates
}},
note = {Accessed: 2020-08-14},
note = {Accessed: 2020-08-28},
title = {About issue and pull request templates},
}
@Misc{github,
howpublished = {\url{https://octoverse.github.com}},
note = {Accessed: 2020-08-14},
note = {Accessed: 2020-08-28},
title = {The State of the OCTOVERSE},
}