Perspective: Maintainers vs Contributors

One of the major goals as a software developer is to ensure that what you produce can be used by a variety of people. This concept may manifest itself in ensuring that your end users will find a piece of software as easy to use as the devs already think it is to use (it's obvious, isn't it?), or packaging your apps/coding environments into some kind of distributable container so that they will run consistently across differently configured machines.

What we do and produce is the product of our own perspective; we see the world through our own eyes, and without constant, unadulterated, inhuman, hypervigilance we may find ourselves overlooking certain details from time to time (oh, to be an inhumanly hypervigilant dev).

For example, as a repo creator, you might create a CONTRIBUTING.md file while using <a href="https://blog.github.com/2016-02-17-issue-and-pull-request-templates/">this great feature github has for creating templates for pull requests and issues</a>, which includes putting those new template files in a .github folder, along with your CONTRIBUTING.md to reduce clutter in your root directory  (Contributing.md was indeed in the root directory to start) in your repo that hold other code. Suddenly, unless you're paying attention, this move breaks any links that may have pointed to CONTRIBUTING.md, Like ones from README.md. If you're the owner of a repo, you probably know how to contribute to your own repo (unless it's been a while, or you're particularly decaffeinated), and probably won't be clicking around on various links to try to access information on how to contribute to the repo. As a visitor to a new repository you become a first time user of various bits of documentation associated with the repo. This means that you may look at things that the creator hasn't looked at in ages, or, with a fresh perspective, you may realize that certain documentation is missing or vague in terms or setting up the dev environment, etc. I found the issue of broken links to CONTRIBUTING.md while browsing a repo, and while the pull request was trivial, hopefully it helps anyone else who comes across the repo.




Comments

Post a Comment

Popular posts from this blog

Tinkering with Chrome Headless to Handle Mic Input

This pull request consisted of performing more research for the CodeTalker repository. One of the ongoing issues with the repository is figuring out how to make it easy to capture microphone audio across a variety of operating systems, and then process it in a way that is easy to set up across multiple user's devices (all of which have may use different operating systems). In an earlier attempt to make the development environment more accessible to potential contributors to the CodeTalker repo, I tried to mount all of the scripts that processed microphone audio to a Docker container. The advantage of this was that the Dockerfile, which defines how a docker image (virtual machine) is built can be configured to install and configure various dependencies. These dependencies in this case would be for processing microphone audio (Python libraries, and various microphone hardware handling libraries). This worked great for Unix style machines, because the microphone hardware (and other
Read more

Using Arrow keys to cycle through Mozilla Screenshots

Image
 The Mozilla-Services' screenshots add-on for the Mozilla Firefox browser is a nifty browser add-on that allows you to snip a portion of your browser's screen to create a screenshot that you can then either download to your computer, or host on Mozilla's servers. It also comes with some simple image editing tools to allow you to draw on top of your screenshot, etc.. Screenshots consists of both the add-on itself, and the server that it communicates with. The add-on allows you to capture parts of your browser's window and then save the resulting screenshot to your computer or the cloud. The server provides a UI to browse, edit, and download these screenshots after they have been uploaded by the add-on. The server is written with React, and NodeJs with express routing, and uses a Postgre SQL database to store screenshots and their metadata. I believe the add-on uses IndexedDB to store the current screenshot before it is either downloaded or saved to the cloud. The p
Read more

A look back at Hacktoberfest

While I only made a series of small changes, for Hacktoberfest, I feel that I learned a lot in the process. I learned about the capabilities of VirtualBox, in terms of running nested VMs (no 64 bit VMs can be run inside VirtualBox VMs), and the was introduced to the use of Vagrant for virtualizing a development environment across multiple platforms, and how to get creative by stealing JSON data from live versions of code when my local version was missing data (see the blog post here) . I was also exposed to some simple things that you don't necessarily think about unless you visit an array of repositories as an outsider (previously, my use of GitHub consisted mostly of working on school projects in private repositories). I discovered that if you own a repository, there are some files that may change or be moved that you don't think about--either because you are not the primary user of the file (like CONTRIBUTING.md), or because you overlooked how a change affected the acces
Read more