"Good first issue", implementation. Part 3/4.

Status: Success

    The third issue, in my list of open source issues I have worked with, will be a fix in a README.md for penguinV project (C++ image processing library, which focuses on work with heterogeneous systems. It works with CUDA and OpenCL). 
    The fix would require a simple modernization of a landing page in the repo, just so it would have a better user experience. No special requests have been mentioned, so it was up to the developer to provide creativity and suggest a few changes.



    The first thing that I noticed, was a lack of hyperlinks in descriptions of the tool, so I modified those mentions of the docs that appeared there (just simple markup links to the Master repo). I also wanted to practice with git rebase, so after all necessary commits have been done locally (just a bit more than a lot of them), I squashed all the commits that I had into one by running git rebase -i HEAD~10. The command would pick up 10 commits preceding the commit with HEAD pointer on it and open interactive rebasing window where we can specify that we want to 'squash' all commits after 'picking' the first one. 
    After pushing the lonely squashed commit to my origin repo and reviewing the changes, I was asked to make a few modifications to the commit; but the requester (and the owner of the repo at the same time) did the change by oneself, also fixing my typo along the way. And then, something interesting happened. As I introduced a hint for contributors, they can start by looking at 'Help Wanted' and 'Good First Issue' links, I got an idea of styling these two phrases in the way how actual tags are styled, so I was discussing this possibility with @ihhub. @ihhub suggested to do the change and asked me to do it while @ihhub would be on the phone. And here I knew, here it was, my opportunity to find out how well I know git and how fast can execute all necessary commands. Well, it was faster than if a toddler would do it. I hope. Anyways, I did the change required by adding <kbd></kbd> tags to 'Help Wanted' and 'Good First Issue' and was ready to submit, but git would complain that I didn't have the recent updates, so I can't possible push (the ones added by @ihhub). So, I didn't find a better way but to replicate the changes in my own commit, rebase, and force push it, deleting the commits of @ihhub. It did work, but seemed very amateur, so I have set up my personal goal now - to find out how to add changes without deleting others' commits.



    The community is incredibly welcoming, and, despite me doing rebase, @ihhub asked if I'd like to work on something of my taste! :)

Link to the issue.
Link to the PR.

Comments

Post a Comment

Popular posts from this blog

Two Different Frames of Same VidioCapture

Image
OpenCV Challenge     I believe, this bug is going to be one of the most challenging I have worked on. Not because of complexity of the work, not because of the scale involved, but because the part of the code is brand new to me. STDMETHODIMP SourceReaderCB::OnReadSample(HRESULT hrStatus, DWORD dwStreamIndex, DWORD dwStreamFlags, LONGLONG llTimestamp, IMFSample *pSample) {     CV_UNUSED(llTimestamp);     HRESULT hr = 0;     cv::AutoLock lock(m_mutex);     if (SUCCEEDED(hrStatus))     {         if (pSample)                     CV_LOG_DEBUG(NULL, "videoio(MSMF): got frame at " << llTimestamp);             IMFSample* prev = m_lastSample.Get();             if (prev)             {                 CV_LOG_DEBUG(NULL, "videoio(MSMF): drop frame (not processed)");             }             m_lastSample = pSample;         }     }     else     {         CV_LOG_WARNING(NULL, "videoio(MSMF): OnReadSample() is called with error status: "
Read more

Node.js: fs.open()

    Today, I would like to take a look at one of the widely used functions of Node.js ' fs  library -  open() , and its synchronous version -  openSync() .     The function's purpose is to open a file, specified by a path (the first mandatory parameter of the function). The code of the function is following ( source ): function open(path, flags, mode, callback) {   path = toPathIfFileURL(path);   validatePath(path);   if (arguments.length < 3) {     callback = flags;     flags = 'r';     mode = 0o666;   } else if (typeof mode === 'function') {     callback = mode;     mode = 0o666;   }   const flagsNumber = stringToFlags(flags);   if (arguments.length >= 4) {     mode = validateMode(mode, 'mode', 0o666);   }   callback = makeCallback(callback);   const req = new FSReqCallback();   req.oncomplete = callback;   binding.open(pathModule.toNamespacedPath(path),                flagsNumber,                mode,                re
Read more

Good friend penguinV

Two birds with one "Pull"     As previously said, I was working on OpenCV bug (you can find some details here ). The bug was not something to spend more than 2-3 days on, but the problem that was there - compilation time. OpenCV project is a set of C/C++ files (and CUDA ;-) ), which is supposed to be compiled with "cmake" to generate library(ies), containing compiled code. Everything sounded pretty decent, until the moment when I realized that I would need to compile the entire folder with a bit more than a lot of different modules of different shapes and colours to make any changes to the existing code and test it. And just because the modules with reference one-another, creating a web of dependencies, I would need to compile the whole thing every time, not some of the modules independently ("video" module, "java", "core" etc.). It'd be okay if not the fact that every compilation would take 20 minutes. Not nice. So, I switched
Read more