In chapter 8 and 9 of Teaching Open Source, we read about documentation. Within Jupyter there are not a lot of comments within the code. This can be problematic, and forces us to wait on the replies of more experienced contributors when trying to understand a piece of code. This slows down our progress and the progress of other contributors when they have to take time to answer our questions. There is documentation in the project's Github page, especially when it comes to installation. Lack of documentation is a common occurrence in open source software. We experienced this problem last semester too when working with Tanaguru. There was very little in the way of installation, and much of what there was outdated. Lack of documentation is a common pitfall in open source projects and we should all work harder to contribute.
The exercise involved commenting and documenting on our code within the open source project. Our first issue involved correcting some accessibility problems.We commented on code we changed with explanations of the color values we changed to make some text and buttons more visible. The code that we edited and fixed now stands out somewhat in the source code due to the lack of comments made by other contributors.
No comments:
Post a Comment