16 lines
2.2 KiB
HTML
16 lines
2.2 KiB
HTML
<h1>Bug Fix - C++ Documentation</h1>
|
|
<!-- wp:paragraph -->
|
|
<p>The project I submitted a bug-fix for is <a href="https://github.com/Bhupesh-V/30-seconds-of-cpp">30 Seconds of C++</a>, developed by Bhupesh-V. This project is a simple project is a collection of demonstrations of C++ code, using the standard template libraries. I picked this project, rather than my initially announced project in class, as it was a smaller contribution, and less overall work to finish, as the bug fix is intended to be smaller than the larger contributions. </p>
|
|
<!-- /wp:paragraph -->
|
|
|
|
<!-- wp:paragraph -->
|
|
<p>This project was rather difficult to contribute to. The documentation within the repository itself was rather out of date, not listing what functions still need to be documented. To find an undocumented function to contribute, I ended up searching their pull-requests, in addition to reading two different text documents, and manually checking the names of files. Each folder contains two different text documents (<code>README.md</code> and <code>todo.txt</code>) , which contain different amounts of information on what has been done. </p>
|
|
<!-- /wp:paragraph -->
|
|
|
|
<!-- wp:paragraph -->
|
|
<p>The issue I tried to address was <a href="https://github.com/Bhupesh-V/30-seconds-of-cpp/issues/31">issue #31</a> (Add new methods in their respective directories). Specifically, I implemented C++'s <code>unordered_map</code>'s <code>extract</code> method. I believe my effort was solid in this. I originally went into this assignment attempting to implement <code>list</code>'s <code>push_back</code>/<code>pop_back</code> methods. However, after a quick check I learned that there had already been two different pull requests sent in to implement those functions. Therefore, the function I contributed I didn't initially understand. As such, to properly commit to this project, I needed to first learn the concept before writing the documentation. </p>
|
|
<!-- /wp:paragraph -->
|
|
|
|
<!-- wp:paragraph -->
|
|
<p>As of now, my pull request is merge-able, but there has not been any movement on it. However, I doubt there will be much response to it over the remainder of this semester, as the last pull request accepted was merged in December 11, 2021, with 63 open pull requests. </p>
|
|
<!-- /wp:paragraph -->
|