Hacktoberfest: Open Source Reflections
You know what? This year Hacktoberfest taught me a lot. Among other things, Iāve found that adding emojis to status messages and/or server logs can really help. Iām a front-end developer, but Iām working more on the back-end now, and these ātricksā are helpful. Hereās how to implement them into your development cycle.
š¤ Take Inspiration From Hugging Face
While I was looking for projects to give my contributions, I found out that Hugging Face used emojis in their commit messages. Since Iām trying to find a way to better organize junior developers of my team, I asked myself if it was a good idea to do the same ā and I think it definitely is. Why? Let me go deeper.
First of all, symbols are one of the most important means of communication. Some of you already use emojis in chaptersā titles: so do I, when it makes sense. But these habit is even more important when talking about logs. Thatās why, when I saw that HF were using them in log and status messages, I started to do the same.
Emojis give the opportunity of immediately understand if something goes either right or wrong. Imagine having to read a log on CloudWatch. Sure, there are filters and search inputs, but how hard is it to find what youāre looking for? It can get really frustrating sometimes.
𦽠Accessibility Is Not Just About Sensory Perception
Iām neurodivergent. Just yesterday I took the final tests for an official ADHD diagnosis. I personally donāt have any cognitive deficits, but I might have colleagues who do. In any case, I also tend to get distracted. Having visual feedback that clearly identifies successes and failures is very helpful.
Thatās why I think HFās approach is brilliant. Itās often difficult to find a message that actually helps you understand whatās happening. Not only on AWS, where logs arenāt color-coded for status, but also in the terminal emulator. I saw that HF is using emojis in Python and JavaScript projects, and in my company we use both.
I think Iāll propose adopting emojis across all my teamās projects. I know, itās a simple solution, yet Iād never thought of it before! Itās a small trick that can significantly improve productivity, especially when a team is expanding to include new members. And not everyone speaks the same language, even though we use English.
š Tips and Tricks for Success (and Consistency)
I donāt recommend using too many emojis. It depends a lot on the company you work for, but in general I think there are two essential ones: the green check mark button ā for successes and the red cross mark ā for failures. They are enough to immediately identify what happened, without adding ānoiseā.
Surely if you work in a startup you can go further. In a corporate environment, I suspect some people would start complaining ā at least, here in Italy. In my personal projects Iāve started adding a lot more symbols, but itās just another way to get into the habit. I like to add a broom š§¹ for cleaning.
There are dozens of them. The security-related ones are very useful, in my opinion, like keys š and locks š. Or even bugs š. Itās your choice, but please donāt overdo it! Many implementations are tied to a specific programming language, such as Rust which has its own symbol š¦ (and Iāve seen it used around before).
Itās a good idea to add a legend in the documentation and, perhaps, adopt a specific guideline for the entire team. I think I will do this for both my personal projects and those of my company. Not only because itās kawaii, but also because I find it really useful. Others have probably been doing it for years.
