whosthat: Minimal command-line Rolodex

Leave a comment

I have a hard time keeping track of the cast of characters in my job. There’s so many projects, and so many people who work on each. A dozen times a day I have two questions: who’s that, and who works on XYZ.

I’ve been looking for a solution for this that works with how I work and think, and everything that I found suffered from one or more of the following problems:

  • Windows-only
  • Doesn’t sync between my machines
  • Data hosted somewhere that corporate security would frown on
  • Expensive

I finally decided that what I needed was something that I host myself, which syncs between my various machines, and which I can use from the command line, because that’s where I spend most of my time.

So, here it is: https://github.com/rbowen/whosthat

whosthat is written in Perl (because I like Perl), runs from the command line, and stores its files in simple text files (YAML) that I can sync between different machines via rsync or OwnCloud or Dropbox or whatever.

The two main functions are:

whosthat Rich

Returns details about records where the name or email address matches “Rich”

whoworkson openstack

Returns all records where the project or “team” matches “openstack”.

Behind the scenes, there are people records, project records, and team records.

People consist of a name, email address, notes, and what project or team they work on.

A project is, initially, an open source project, since that’s what I care about in my job, but there’s no reason it has to be. It’s any project that they work on.

And a team was, initially, the team or department within my company that someone is on, or the AWS Service they work on. But more generally, it could also be what company they work on, for tracking of people outside if my company.

Data is stored in YAML files. There’s also a addwho and editwho command for doing those things. But these just open the YAML file in your $EDITOR. It’s intentionally very simple. Could get more features over time, but this does what I need it to do.

There are a few things in this that are AWS specific. In particular, it assumes, by default, that email addresses  are @amazon.com and it links to our internal system for additional user info. I’ll try to make these configurable eventually, but right now that’s hard-coded.

If something like this is of interest to you, please do try it out. It’s Apache licensed and free. If you speak Perl, your patches are welcome. If you don’t, your ideas are welcome, but no guarantees that I’ll get anything done, since it’s very much a scratch-my-own-itch project.

 

Lost passport; Found passport; Headed home.

Short version: Lost my passport; Found it again; Heading home.

This morning I checked out of my hotel in Paya Lebar (Singapore) and went to the airport. I went around 10am, not because my flight was imminent, but because Changi airport is the world’s best airport and I wanted to see more of it.

When I got to the airport, the checkin desks weren’t open yet, so I sat by an outlet and started some writing that I have been putting off. About an hour later, my manager says, on our team chat, that he lost his passport at TSA on the way to Amsterdam, and had to go back and get it.

So … I check my pocket for my passport … and it’s not there.

I went to the info desk to ask about lost and found, and it’s unstaffed. The security guy, who doesn’t understand a lot of English, says, yeah, someone will be there soon.

I went through all of my bags three times, emptying them on the floor, and started to panic. Thinking back, I KNOW that I had it when I left the hotel, and that I put it in my back pocket, rather than in the pocket of my bag where it goes. Ergo, I must have left it in the taxi.

After waiting on hold for more than an hour with the taxi company and opening a lost item report on their website, I start trying to figure out what happens if I don’t find it. That leads to an hour on hold, and then being passed around to various people at the US Embassy. And of course it’s Sunday, so nobody has any actual answers.

And then several hours talking with my company travel folks, and getting passed around to one person after another after another and back to the beginning and FINALLY getting a straight answer that I can get my flight moved to tomorrow, so that I can go to the embassy.

More time talking to the embassy tells me that an emergency passport takes 1-2 days, best case. So back with the travel agency to find a hotel. And back with the taxi company checking on the lost item report.

Anyways, after about 6 hours, I went downstairs looking for some food, and … there’s another info desk, and they have my passport. Apparently I dropped it as I came in the door when I arrived, and it’s been there all day.

So rather than seeing Changi Airport, I spent 6 or 7 hours on the phone, being as stressed almost to the point of tears.

So I’m in the Blossom Lounge now, and heading home soon.

Becoming an ASF Committer

I’ve been mentoring some folks at work who want to become committers in various ASF communities, and wrote the following as part of trying to document that advice.

Note that I’ll likely update this article periodically to reflect edits on my internal version of this doc. Your feedback would be very helpful in that process, as I try to help my colleagues be better upstream citizens.

Disclaimer

Nothing in this post should be construed as a guarantee. You can do everything listed here, for years, and still not become a committer. This is because the decision is made by individuals on the project PMC, who do things for their own reasons.

On the contrary, this document discusses how things should work, and sometimes do work, in some Apache Software Foundation (ASF) projects, but might not on the one you’re interested in.

Beneath each of these recommendations is the assumption that you are acting in good faith, for the benefit of the project. Simply attempting to check these boxes to game the system will reflect badly on you, and probably on your employer, too.

Becoming a Committer

It’s important to remember that becoming a committer is not a reward, or a recognition, so much as that it is the project expressing self-interest. That is, people are added as a committer to a project because it benefits the project, not because it’s some kind of pat on the back for the individual in question. As such, every behavior suggested here is about advancing the interests of the project. It is critical that you think, first and foremost, about being a project owner, and working towards the benefit of the project and its users.

These, therefore, are the behaviors that you should exhibit if you want to become a committer, and then a PMC member, on an ASF project. (These are not unique to ASF projects, of course, but process will differ greatly from one project to another, and are largely similar among ASF projects.)

Read the mailing list

ASF projects communicate on the mailing list. If you want to be involved in the community, you must set aside time every week (preferably every day) to keep current on the community discussion.

When first participating in an ASF project, you can (and should) look back several months (or as far as you have time for) to see what has been discussed recently. You can do this at http://lists.apache.org/

A growing number of projects also have a presence on Slack, Discord, or somewhere else. Find where that is, and become a regular. A shrinking number of projects have a presence on Libera IRC – mostly the much older projects. This is where you’ll connect with the older members of the projects and learn more of the ancient project lore.

Contribute code (and other things)

If you want to become a committer, you should make significant contributions to the project. The most obvious thing to contribute to a software project is code. Code contributions should be diverse in terms of size and significance. That is, you should work on small issues and large. You should collaborate with others on features and fixes, and you should propose significant changes yourself. You should dig up old tickets, and work towards resolving them.

In particular, you should work on code that is of benefit to all users, rather than focusing solely on features that benefit only yourself, or your employer. As a project owner, you should care about the entire health and sustainability of the project.

Code contributions are not the only type of contribution that counts towards becoming a committer, it’s just the most common. Design, documentation, marketing, event management, and many other ways of contributing to the success of a project are also often considered in making someone a committer. While the term “committer” implies committing code, it can also be interpreted as someone who is committed to the project.

End user support

Answering end user questions has many benefits. It’s the best way to establish expertise in aspects of the software that effect actual users, and, thus, the best way to stay in touch with user concerns. It’s also the way to establish and maintain visibility in the project community, because your name is always visible on the mailing list.

Caution: Do not just jump in and answer every question with visibility as a primary goal. Ensure that your answers are actually useful, and contribute something to the conversation. Simply posting to every conversation, particularly when someone else has already offered a good answer, can be perceived as attempting to game the metrics.

Documentation

Improving the documentation is one of the most effective things that one can do to improve the user experience. If you notice many people asking similar questions, this is usually an indication that the documentation is weak on that point. Fix it. When the question is asked again, point to the improved documentation, and ask for feedback as to how it could be further improved.

Take criticism of the documentation as a challenge, rather than a personal criticism.

Review PRs and tickets

Dig into unmerged PRs and outstanding tickets. Figure out how to navigate the process to get an old ticket resolved, or a PR merged.

This is an investment in the project in two ways.

The obvious improvement is getting an issue fixed or a PR merges, thus enhancing the project. The less obvious way is that ancient tickets, and unmerged PRs, communicate that the project is not actively maintained, and that user issues are being ignored. This undermines project trust. Thus, addressing these things builds community trust, and increases your personal value to the project.

Be visible

Participate meaningfully in discussions on the developer mailing list. Drive discussions through to action. Advocate for changes that help yourself and your employer, but also for those that improve the project as a whole.

Get to know the important characters on the project, and what their priorities are. Help them achieve those priorities in whatever way you can. Figure out who you can best collaborate with to advance your own personal interests in the project, but also the overall health of the project and community.

Start conversations around topics you’re passionate about, and volunteer to be the one to address them.

Do not, however, just talk to be seen. Nobody is fooled by that.

Vote on releases (non-binding)

Vote on release candidates and releases (non-binding).

Note that a vote should always mean that you’ve actually tested, so testing releases is implied here, too. Indicate what platform(s) you’ve tested on, and what was the nature of the tests that you performed. Testing releases on a variety of platforms and configurations is a very valuable piece of information for projects with limited testing infrastructure.

While these votes don’t “count” towards making a release official, it’s both hugely beneficial for the project, and increases your visibility.

Give talks

Propose talks to conferences about the project, and about how your employer’s customers are using it.

Proposing “Introduction to Apache Woobly” talks has many benefits. It is a great way to get the word out about the project. It’s good for establishing yourself as an expert in the field. It educates users (and potential customers) about operating the software. And it will help you identify what’s actually important about the software, how people use it, and what kinds of questions real users are asking about the software.

ApacheCon is the obvious place to give these talks, but also look for conferences about the general technology space around the project you’re contributing to.

Once you’re a committer …

If and when you achieve your goal of becoming a committer, don’t consider your journey done.

Becoming a PMC member is a continuation of the same path. Continue to do all of the above things, focusing more on the health of the project as a whole, rather than just your personal interests, or those of your employer or manager.

Also, take an active interest in other contributors – both those on your team, and those with other employers. Mentor them in following the same path that you followed. Encourage them. Celebrate them, and mention them to other contributors. This is an investment in the future of the project, so that, some day, when you move on to something else, the project will live on.

Interest across multiple projects, and at the Foundation-wide level, is the start of the path to becoming a Foundation Member, if that is something that interests you.

Summary

Finally, a reminder – there’s no way to guarantee promotion to committer or the PMC. However, if you make your goal the improvement of the project, rather than just about personal promotion, and approach these recommendations as a path to project ownership, in good faith, these are your best path towards that goal.

Resources

Find your project’s committer and PMC membership lists at https://projects.apache.org/

Read mailing list archives at https://lists.apache.org/

Find your contribution count to date on Github, for example: https://github.com/apache/hadoop/graphs/contributors (You can drag a date range to narrow it down to recent contributions.)

View past board reports from your project at https://www.apache.org/foundation/board/calendar.html This is a good way to judge the rate at which a given project adds committers and PMC members. It’s also a way to compare how long other individuals took to attain committer status.

Reading: The Sword of Shannara

2 Comments

I’ve started reading The Sword of Shannara. Re-reading, I should say, and it might even be the third time. It holds up, and is as gripping now as when I first read a beat-up copy from the school library at Florida High School in 1982.

The Sword of Shannara - Wikipedia

40 years later, Terry Brooks is still telling stories, but these are the ones – the original trilogy – that I keep coming back to. There are passages that I remember from the first time, and others that are new again.

I’m looking forward to this new old adventure.

Reading

I finished The Girl on the Porch by Richard Chizmar. I picked it up in the first place because Stephen King wrote the book Gwendy’s Button Box with this author so I expected good things. It was okay but not terribly interesting.

I’m looking forward to reading The Navigator’s Children (Tad Williams) later this year but it doesn’t come out until November.

I think I might take a shot at reading the Shannara series again since it’s been 30+ years and so much has been added since then.

Create > Consume

This year, as every year, I resolve to create more than I consume.

(edit) WARNING: this was a shower thought and seemed very profound at the time. In editing afterwards, perhaps not so much. Your mileage may vary.

Of course this can be translated in a number of different ways, and I mean them all. But while I hope to create more in quantity than I consume, I realize that’s not always practical.

Consider, for example, if you consume a cheeseburger. In theory, that consumed the time and resources of at least five different businesses. There’s the bread, the beef, the cheese, packaging, and the company that sold it to you.

But in reality, you probably only consumed a few seconds of each of their time, if that. Likewise, if I try to create things that are a benefit to more than just myself, I can have a similar distributed influence.

So what I tend to mean, by my resolution, is that I intend to spend more time creating than consuming, and thereby do my part contributing to the whole.

This is a really hard thing to do in practice, because life is tedious, stressful, and exhausting. And at the end of the day, I really only want to sit and drink in the pablum of television.

So, anyway, here’s to New Year’s resolutions, and meaning them honestly.

Knife 5 – Cthulu

Knife 5 is another Damascus blade with a Canary wood handle and a Cthulu mosaic pin in the lanyard hole.

Initially I was making a purple heart handle but it broke while I was clamping/epoxying. Oops. So I started over.

Scheduling for later because it’s a Christmas present.

The Margin Is Too Narrow