Creating a concept for a dev diary

As we all do, I work on different projects: There are a few at work, a few of my own hobby projects and occasionally I contribute to open source projects. They all have different commands for buildings, different commands for testing, different commands for deploying and some even have different commands for committing and pushing your changes. And sometimes you just forget that one pesky command for what you are trying to do right now.

Recently as I was fixing an issue for the rust-lang project, I had forgotten the command to execute just the test suite for just that one part of the compiler I was working one. Running all the tests takes a long time, so I went searching in my history file. I found the command I was looking for, but I also saw some of the other ones I had used the last time I was contributing to the rust-lang project. I copied them into a separate file and saved it for a rainy day. I forgot that one command today - obviously I am going to forget one or more commands in the future.

And then it hit me. I should make this more organized than just copying a few commands. I should add some context: Put in some comments and maybe add a concept of order of execution. With that extra information added to the file it could even serve as documentation for some projects. Just like you can transfer around postman files within your project group, you could transfer this file around and have it injected into your history file and you would be good to with a reverse search in your terminal.

I think I will call this a 'dev diary'. It is a file where I can easily store some commands and comments about the current projects I working on so that I can yank it back in the future where I probably have forgotten about it. It is me writing something now for me in the future.

Discussion, links, and tweets

I'm a developer and CS graduate. Follow me on Twitter; you'll enjoy my tweets.

I also keep an "ask me anything" type of project in a repository on GitHub (naturally!). Feel free to ask me a question.