Enhancing Open-Source Projects: The Synergy Between Code Readability Metrics and User Experience

Aisha Khalid; Farah Haneef; Fatima Waseem

Authors

Aisha Khalid Department of Computer Science, National University of Modern Languages, Islamabad, Pakistan.
Farah Haneef Department of Software Engineering, Capital University of Science and Technology, Islamabad, Pakistan.
Fatima Waseem Department of Computer Science, National University of Modern Languages, Islamabad, Pakistan.

Keywords:

Code Comments, Code Structure, Version Control, User Experience, Code Readability

Abstract

Introduction /Importance of Study: The open-source project is a key driver of innovation in the so-called open ecosystem. However, the readability of code is still a major obstacle in having users successfully engaged and contributing.

Objective: This study explores how Code Readability Metrics Impact User Experience (UX) in OSS projects.

Novelty Statement: We examine code comments, structure of the code, and version control to discover their impact on user understanding and satisfaction.

Material and Method: For this, a survey has been conducted. In this survey, handed out to upper division (computing major) or first-year computer science students at university/graduates and post-grads in similar positions), we gathered feedback on projects written in Kotlin, Python, Swift, JavaScript, and Flutter.

Results and Discussion: Results show that readability correlates positively with a user's perceived experience. The clarity in your structure, commenting on all parts of the code, and great version control lead to better user reception. The study’s findings show that when code is well-organized and understandable, users tend to have more positive experiences and like to use the software.

Concluding Remarks: Our study has demonstrated that better code readability translates into enhanced user experiences, which can inform developers and project managers on how best they can improve their practices.

References

E. Dias, P. Meirelles, F. Castor, I. Steinmacher, I. Wiese, and G. Pinto, “What makes a great maintainer of open source projects?,” Proc. - Int. Conf. Softw. Eng., pp. 982–994, May 2021, doi: 10.1109/ICSE43902.2021.00093.

U. A. Mannan, I. Ahmed, and A. Sarma, “Towards understanding code readability and its impact on design quality,” NL4SE 2018 - Proc. 4th ACM SIGSOFT Int. Work. NLP Softw. Eng. Co-located with FSE 2018, pp. 18–21, Nov. 2018, doi: 10.1145/3283812.3283820.

G. von Krogh, “Open-Source Software Development,” MIT Sloan Manag. Rev., Apr. 2003, Accessed: Jan. 10, 2025. [Online]. Available: https://sloanreview.mit.edu/article/opensource-software-development/

M. Krishnamurthy, “Institutional Repositories, Open Source Options, and Libraries,” Program, vol. 42, no. 1, pp. 48–55, 2008, doi: 10.1108/00330330810851582.

S. Pinfield et al., “Open-access repositories worldwide, 2005–2012: Past growth, current characteristics, and future possibilities,” J. Assoc. Inf. Sci. Technol., vol. 65, no. 12, pp. 2404–2421, Dec. 2014, doi: 10.1002/ASI.23131.

O. Jarczyk, B. Gruszka, S. Jaroszewicz, L. Bukowski, and A. Wierzbicki, “Github projects. quality analysis of open-source software,” Lect. Notes Comput. Sci. (including Subser. Lect. Notes Artif. Intell. Lect. Notes Bioinformatics), vol. 8851, pp. 80–94, 2014, doi: 10.1007/978-3-319-13734-6_6.

“An empirical study of the first contributions of developers to open source projects on GitHub | IEEE Conference Publication | IEEE Xplore.” Accessed: Jan. 10, 2025. [Online]. Available: https://ieeexplore.ieee.org/document/9270396

A. Seker, B. Diri, H. Arslan, and M. F. Amasyalı, “Open Source Software Development Challenges: A Systematic Literature Review on GitHub,” https://services.igi-global.com/resolvedoi/resolve.aspx?doi=10.4018/IJOSSP.2020100101, vol. 11, no. 4, pp. 1–26, Jan. 1AD, doi: 10.4018/IJOSSP.2020100101.

“5 Types of Programming Languages | Coursera.” Accessed: Jan. 10, 2025. [Online]. Available: https://www.coursera.org/articles/types-programming-language

“The Java Programming Language, 4th Edition: Arnold, Ken, Gosling, James, Holmes, David: 9780321349804: Amazon.com: Books.” Accessed: Jan. 10, 2025. [Online]. Available: https://www.amazon.com/Java-Programming-Language-4th/dp/0321349806

“Programming Kotlin | Programming | Print.” Accessed: Jan. 10, 2025. [Online]. Available: https://www.packtpub.com/en-us/product/programming-kotlin-9781787126367

T. Mikkonen and A. Taivalsaari, “Using JavaScript as a Real Programming Language,” 2007, doi: 10.5555/1698202.

M. Rebouças, G. Pinto, F. Ebert, W. Torres, A. Serebrenik, and F. Castor, “An empirical study on the usage of the swift programming language,” 2016 IEEE 23rd Int. Conf. Softw. Anal. Evol. Reengineering, SANER 2016, vol. 1, pp. 634–638, May 2016, doi: 10.1109/SANER.2016.66.

“Python Programming Language | USENIX.” Accessed: Jan. 10, 2025. [Online]. Available: https://www.usenix.org/conference/2007-usenix-annual-technical-conference/presentation/python-programming-language

B. W. Kernighan and D. M. Ritchie, “The C programming Language,” 1988.

P. Bhattacharya and I. Neamtiu, “Assessing programming language impact on development and maintenance: A study on C and C++,” Proc. - Int. Conf. Softw. Eng., pp. 171–180, 2011, doi: 10.1145/1985793.1985817.

R. P. L. Buse and W. R. Weimer, “Learning a metric for code readability,” IEEE Trans. Softw. Eng., vol. 36, no. 4, pp. 546–558, 2010, doi: 10.1109/TSE.2009.70.

“(PDF) A Review of Career Selection Models.” Accessed: Jan. 10, 2025. [Online]. Available: https://www.researchgate.net/publication/342145623_A_Review_of_Career_Selection_Models

R. P. L. Buse and W. R. Weimer, “A metric for software readability,” ISSTA’08 Proc. 2008 Int. Symp. Softw. Test. Anal. 2008, pp. 121–130, 2008, doi: 10.1145/1390630.1390647.

D. Oliveira, R. Bruno, F. Madeiral, and F. Castor, “Evaluating Code Readability and Legibility: An Examination of Human-centric Studies,” Proc. - 2020 IEEE Int. Conf. Softw. Maint. Evol. ICSME 2020, pp. 348–359, Sep. 2020, doi: 10.1109/ICSME46990.2020.00041.

N. Al Madi, “How Readable is Model-generated Code? Examining Readability and Visual Inspection of GitHub Copilot,” ACM Int. Conf. Proceeding Ser., Aug. 2022, doi: 10.1145/3551349.3560438.

M. Rajanen and D. Riehle, “Open Source Usability and User Experience,” Computer (Long. Beach. Calif)., vol. 56, no. 02, pp. 106–110, Feb. 2023, doi: 10.1109/MC.2022.3219634.

S. Scalabrino, M. Linares-Vásquez, R. Oliveto, and D. Poshyvanyk, “A Comprehensive Model for Code Readability,” J. Softw. Evol. Process J. Softw. Evol. Proc, vol. 00, pp. 1–29, 2017, doi: 10.1002/smr.

J. Borstler and B. Paech, “The Role of Method Chains and Comments in Software Readability and Comprehension-An Experiment,” IEEE Trans. Softw. Eng., vol. 42, no. 9, pp. 886–898, Sep. 2016, doi: 10.1109/TSE.2016.2527791.

J. Cheng and J. L. C. Guo, “How do the open source communities address usability and UX issues? An exploratory study,” Conf. Hum. Factors Comput. Syst. - Proc., vol. 2018-April, Apr. 2018, doi: 10.1145/3170427.3188467.

Q. Mi, J. Keung, Y. Xiao, S. Mensah, and Y. Gao, “Improving code readability classification using convolutional neural networks,” Inf. Softw. Technol., vol. 104, pp. 60–71, Dec. 2018, doi: 10.1016/J.INFSOF.2018.07.006.

D. Oliveira, R. Santos, F. Madeiral, H. Masuhara, and F. Castor, “A systematic literature review on the impact of formatting elements on code legibility,” J. Syst. Softw., vol. 203, p. 111728, Sep. 2023, doi: 10.1016/J.JSS.2023.111728.

F. Haneef et al., “Using network science to understand the link between subjects and professions,” Comput. Human Behav., vol. 106, p. 106228, May 2020, doi: 10.1016/J.CHB.2019.106228.

F. Haneef, R. Ayaz Abbasi, M. N. Noor, F. Waseem, and A. Khalid, “Identifying Significant Factors Associated with Career Selection: A survey based study in Pakistan,” Pakistan J. Eng. Technol. & Sci., vol. 12, no. 1, pp. 104–116, Jul. 2024, doi: 10.22555/PJETS.V12I1.1090.

“(PDF) The analysis of categorical data: Fisher’s exact test.” Accessed: Jan. 10, 2025. [Online]. Available: https://www.researchgate.net/publication/237336173_The_analysis_of_categorical_data_Fisher’s_exact_test

M. N. Noor, T. A. Khan, F. Haneef, and M. I. Ramay, “Machine Learning Model to Predict Automated Testing Adoption,” https://services.igi-global.com/resolvedoi/resolve.aspx?doi=10.4018/IJSI.293268, vol. 10, no. 1, pp. 1–15, Jan. 1AD, doi: 10.4018/IJSI.293268.

“Chi-Square Test of Independence | Formula, Guide & Examples.” Accessed: Jan. 10, 2025. [Online]. Available: https://www.scribbr.com/statistics/chi-square-test-of-independence/