DEV Community: Ojay

Enforcing Git Branch Naming Standards: Tools and Tips for Developers

Ojay — Mon, 16 Dec 2024 17:26:16 +0000

Introduction

Writing code is for humans, not just machines. Every aspect of software development, from variable naming to project structure, should prioritise clarity and collaboration. One often overlooked element of developer communication is branch naming. A clear and consistent branch naming convention can transform a chaotic Git workflow into a seamless, human-friendly process.

In this article, we’ll explore how to implement branch naming conventions that enhance collaboration and productivity on GitHub. Whether you are working on a solo project or a large team, these practices will help you stay organised and efficient.

Why Branch Naming Matters

Branch names are more than just labels. They:

Communicate the purpose of a branch at a glance.
Help team members quickly understand ongoing work.
Tie development efforts to specific features, fixes, or issues.
Simplify code reviews, testing, and deployment processes.

A poorly named branch can confuse collaborators and lead to mistakes, while a well-named branch sets the stage for smooth collaboration.

A Simple Naming Convention

Here’s a flexible structure for naming your branches:

<type>/<scope>/<short-description>

type: What kind of work is being done? (e.g., feature, fix, chore, etc.)
scope: Which part of the project does this branch affect? (e.g., ui, api, etc.)
short-description: A concise description of the branch’s purpose.

Examples of Common Branch Types

Feature Development
Used for building new features.
Example: feature/ui/login-page
Bug Fixes
Used for resolving bugs in the code.
Example: fix/api-endpoint-error
Chores
Used for non-feature tasks like refactoring or updating dependencies.
Example: chore/update-dependencies
Hotfixes
For urgent fixes to production.
Example: hotfix/security-patch
Releases
For preparing production releases.
Example: release/1.0.0

Narrowing Down Features

Sometimes, work on a feature needs to be divided into specific tasks like UI implementation and API integration. For these cases, specify the scope:

UI Work: feature/ui/login-page
API Work: feature/api/login-endpoint

This division makes it easier for teams to work in parallel without conflicts.

Enforcing the Convention

To ensure developers follow the naming convention:

Document It: Include the rules in a CONTRIBUTING.md file.
Use Templates: Add a checklist in your pull request template.
Set Up Automated Checks: Use GitHub Actions or pre-push hooks to validate branch names.

Conclusion

Adopting a branch naming convention is a small change with a big impact. It fosters better communication, reduces errors, and improves productivity across teams. As you implement this in your projects, remember: writing code is for humans. Every practice that enhances clarity and collaboration brings you closer to creating great software.

Enforcing Git Branch Naming Standards: Tools and Tips for Developers

Ojay — Mon, 16 Dec 2024 17:26:16 +0000

Introduction

Why Branch Naming Matters

Branch names are more than just labels. They:

Communicate the purpose of a branch at a glance.
Help team members quickly understand ongoing work.
Tie development efforts to specific features, fixes, or issues.
Simplify code reviews, testing, and deployment processes.

A poorly named branch can confuse collaborators and lead to mistakes, while a well-named branch sets the stage for smooth collaboration.

A Simple Naming Convention

Here’s a flexible structure for naming your branches:

<type>/<scope>/<short-description>

type: What kind of work is being done? (e.g., feature, fix, chore, etc.)
scope: Which part of the project does this branch affect? (e.g., ui, api, etc.)
short-description: A concise description of the branch’s purpose.

Examples of Common Branch Types

Feature Development
Used for building new features.
Example: feature/ui/login-page
Bug Fixes
Used for resolving bugs in the code.
Example: fix/api-endpoint-error
Chores
Used for non-feature tasks like refactoring or updating dependencies.
Example: chore/update-dependencies
Hotfixes
For urgent fixes to production.
Example: hotfix/security-patch
Releases
For preparing production releases.
Example: release/1.0.0

Narrowing Down Features

Sometimes, work on a feature needs to be divided into specific tasks like UI implementation and API integration. For these cases, specify the scope:

UI Work: feature/ui/login-page
API Work: feature/api/login-endpoint

This division makes it easier for teams to work in parallel without conflicts.

Enforcing the Convention

To ensure developers follow the naming convention:

Document It: Include the rules in a CONTRIBUTING.md file.
Use Templates: Add a checklist in your pull request template.
Set Up Automated Checks: Use GitHub Actions or pre-push hooks to validate branch names.

Conclusion

My Journey as a Backend Developer: Tackling Complex Problems and Embracing the HNG Internship

Ojay — Fri, 05 Jul 2024 23:56:18 +0000

Hey there! I'm a passionate software developer from Nigeria, and today, I want to share a recent challenge I faced and how I overcame it. I believe that a big part of being a backend developer is not just about writing code, but also about solving problems and continuously learning. Plus, I want to tell you all about the exciting journey I'm about to start with the HNG Internship and why I chose this path.

The Challenge: Optimizing Database Performance

Recently, I was working on a project that required handling a large volume of data in a PostgreSQL database. Everything seemed to be running smoothly until we started experiencing significant performance issues. Queries that used to take milliseconds were now taking seconds, and the overall user experience was deteriorating.

Step-by-Step Solution

1. Identifying the Bottleneck

The first step in solving any problem is understanding its root cause. I started by using the PostgreSQL slow query log to identify which queries were taking the most time. It turned out that several of our JOIN operations were causing delays due to the large datasets involved.

2. Analyzing and Optimizing Queries

Next, I analyzed these slow queries to see if they could be optimized. I found that some of the JOIN operations were unnecessary and could be replaced with simpler subqueries. Additionally, I made sure to use indexes effectively. By adding indexes to the columns used in the WHERE clause and JOIN operations, the query performance improved significantly.

3. Implementing Caching

Despite optimizing the queries, there were still some performance issues due to the sheer volume of data being processed. To tackle this, I implemented caching. By caching the results of frequently accessed queries, I was able to reduce the load on the database and speed up response times for users.

4. Database Sharding

For a more long-term solution, I explored database sharding. This involved splitting the large dataset into smaller, more manageable pieces, and distributing them across multiple servers. By doing so, each query had to process less data, further improving performance.

Lessons Learned

This experience taught me a lot about database optimization and the importance of efficient query design. It also reinforced my belief that problem-solving is at the heart of backend development. No matter how complex the issue, there's always a way to break it down and find a solution.

Embarking on the HNG Internship

I'm thrilled to share that I've been accepted into the HNG Internship! This is a fantastic opportunity for me to learn, grow, and connect with other passionate developers. The HNG Internship is known for its rigorous training and hands-on projects, and I can't wait to dive in.

One of the main reasons I chose to join the HNG Internship is the emphasis on real-world experience. As someone who thrives on tackling challenging problems, I believe this internship will provide me with the perfect platform to sharpen my skills and take my career to the next level.

Conclusion

Being a backend developer is an exciting journey filled with challenges and opportunities for growth. By sharing my experiences and solutions, I hope to inspire others to embrace problem-solving and continuous learning. I'm looking forward to the incredible journey ahead with the HNG Internship and can't wait to see where this adventure takes me!

Thank you for reading, and if you're interested in learning more about the HNG Internship or hiring talented developers, check out HNG Tech for more information.

I failed a coding Interview 😞

Ojay — Sun, 02 Oct 2022 21:44:59 +0000

“Hi Oj, thanks for meeting Matt today for a second interview. After careful consideration, we decided not to move forward at this moment…”

This is a response I received from a CTO looking to hire a React Native developer. So, what did I learn?

As a Nigerian living in Nigeria who is trying to switch jobs with an offshore company or start a career with an offshore company, It can be discouraging to hear comments like "So you have to be in the US for this job" or "we assumed you are in the US" despite the remote tag in the job description and even after a series of conversations with recruiters/hiring managers and attempting to pitch yourself and your skills; this could even be after you have scheduled a call or gotten on a brief Introductory call.

But, unlike so many prior interactions with recruiters/hiring managers, this was not the case this time, because this specific company was more concerned with your competency than your location. After an initial introductory call with the CTO, who seemed very cool, I believed this could be a good team to work with because the personality of an organisation's leader can reveal a lot about its working culture. I was already imagining myself working with this amazing team.

I was thrilled to learn more about the technical interview requirements, which turned out to be a React test rather than the more conventional algorithms test. I believe myself to be a proficient React developer and have worked with a few teams.

Fast forward to the feedback after the technical Interview.

“Hi Ojonugwa, Thank you for taking the time to interview at XYZ company (intentional omission). Unfortunately, we will not be moving forward at this time. I wish you the best in your future endeavours.”

Feedback like this can cause you to go to bed earlier than you intended. Could it be that I was nervous or rusty from attending live-in technical interviews? I thought about it for a while before deciding to contact the CTO once more.

“Hello, Apologies for bothering you, but is it possible for me to retake the technical interview? I believe it would only be reasonable to request the opportunity to participate in another technical interview given that I consider myself to be a good developer and have been a part of a few teams that have developed decent products that have scaled. I admit to feeling nervous during my most recent attempt because it had been a year since my last live coding interview, hence the performance. I look forward to your response :).”

To my amazement, the CTO agreed to a second interview.

This time, I practiced a little based on my prior experience and concentrated on the nervousness that comes with technical interview time limits.

Fast forward to the feedback after taking the second technical Interview.

“Hi Oj, thanks for meeting Matt today for a second interview. After careful consideration, we decided not to move forward at this moment. Feedback was similar, we believe you are a knowledged developer, but the way you structure your components and your problem-solving procedures can be improved. Thanks again for being interested in XYZ company (intentional omission), best of luck!”

This time, instead of being hard on myself, I opted to carefully consider the CTO's feedback.

So What did I learn?

Technical interviews focus on your problem-solving approach rather than merely your ability to complete the given tasks.
Try to demonstrate your technical prowess in your code rather than applying the quick fix to the task at hand.
As much as possible, communicate your steps and intentions aloud.
Prior to the interview, enquire as much as you can about the requirements and the other things they expect to see from you outside your ability to do the task at hand.

Importantly, honest and detailed feedback should drive you to continue learning and improving your competence.

What Software organisations mean by Development, Testing, Staging, and Production environments

Ojay — Tue, 26 Apr 2022 05:25:55 +0000

I couldn't understand why we had these environments separated when I first joined my first software development team; it seemed logical to me that if everything worked well, we could move from the Development environment to the Production environment, but understanding why these environments are set in place quickly changed my mind.

So let's take a look at the different environments, their uses, and why it is important to use them. It will become clear why we have these environments once you understand what they are intended for.

Development Environment

On your local PC, This is where you will

Carry out all of your code updates using a number of productivity tools that may or may not be deployed to production alongside your code.
Create new commits and branches, as well as see a copy of your teammates' commits and branches.

The developer keeps this environment up to date and contains the most recent version of the application. It'll be linked to a local database and (or) a data source via an API, allowing you to write code without affecting the real data. Because numerous employees will be working in the development environment on separate machines, you'll most likely be in charge of branch merging.

It's important to note that nothing you do in the development environment affects what users see when they visit the application.

Test or QA (Quality Assurance) Environment

This environment gives software testers access to the most recent version of the application from development, allowing them to completely test it. Following that, testers are given the responsibility of

Raising Bug awareness (if any are found)
Checking out developers' most recent bug fixes.
Submit a report on a common revision so that developers are aware of the issues discovered and whether specific concerns raised by testers have been addressed in the development code previously.

Staging Environment

To imitate the production environment, fresh versions of the application are constructed, tested, and reviewed in the staging environment before going live. Hardware and servers that are similar to those used in the production environment are commonly evaluated during the staging phase of the software lifecycle. In contrast to the development site, the staging site serves as a final Product Testing zone separate from the development and production environments.

When doing significant updates, the staging environment helps you to discover and resolve any issues that may surface. All data migrations and configuration changes will also be tested here.

This is when you can also show a client how things work and look if you have one. They'll be able to see how everything will operate once it's online, and they'll be able to provide you with any input you require.

Production Environment

This is the most recent version of the application that is available to end-users. Except for scheduled updates, this version should not be changed.

Users use this environment, and organisations make money in this environment, so any errors at this stage must be avoided at all costs. That's why you need to finish all of the tests in the other two environments first.

It's worth noting that most small software teams (and startups) have only three environments (dev, stage, and production), whereas large corporations have a testing or quality assurance (QA) environment between development and staging.

If you found this post useful, please like and share it, and leave your thoughts and questions in the comments section below.

Stop Thinking Plenty Before You Act (The Analysis Paralysis Syndrome)

Ojay — Mon, 11 Jan 2021 06:55:33 +0000

Growing up I was so Logical that I analyzed every gesture, word, action, decision, and situation from every person I found myself with or every place I found myself due to my melancholic nature. Omo! it was so bad that I did not make certain decisions, take necessary actions, or make important requests because I felt I already knew the outcomes of such situations with my analogy and It was going to turn out against my favor.

If you're like the excessively thinking me or you find yourself sometimes overthinking stuff without acting and your answer is yes to most (if not all) the questions below, then this article is specifically for you.

Do you ask questions like: What If I don't match up or I don't have what It takes? What if the reply to this request turns out to be a no?
Do you feel the need for 100% certainty before jumping into action?
Do you decline to apply for a job with a large number of applicants already

Analysis paralysis (or paralysis by analysis) describes an individual or group process when overanalyzing or overthinking a situation can cause forward motion or decision-making to become "paralyzed", meaning that no solution or course of action is decided upon. A situation may be deemed as too complicated and a decision is never made, due to the fear that a potentially larger problem may arise. A person may desire a perfect solution, but may fear making a decision that could result in error, while on the way to a better solution.
https://en.wikipedia.org/wiki/Analysis_paralysis

You can ride above your Temperament and self-esteem

As described by Tim LaHaye in his famous book "Why you act the way you do", he classifies humans into four temperaments:

The Sanguines
The Cholerics
The Melancholy
The Phlegmatic

The first two being on the extroverted side and the latter two on the introverted side. Everyone has a blend of each of these temperaments, of which two are dominant and you will agree with me that temperaments have a major influence on all our actions.

Someone who is an Introvert has a lot of reserved time for thoughts and analogy, this could turn out to be both an advantage and a disadvantage. They often find themselves with the problem of overthinking before acting. Thinking or analysis in itself is not bad because they keep us from acting out of impulse or current emotions, but it turns to be detrimental when it is prefixed with the word "over", because then:

We seek perfection.
We draw conclusions and
We dread rejections

Sometimes you feel under-qualified for certain things. This reminds me of me when I got close to OJ (a beautiful lady during my undergraduate days), gosh! she was so beautiful and good looking I felt so lucky to be her friend. I wanted more (not just on a friendship base), I wanted a relationship, and guess what? you should know the answer by now. I had one job but I literally blew it up, all I needed to do was ask, instead, I found myself asking questions like, do you have what it takes to be in a relationship with her? could she be getting more attention from other guys? don't you think she likes you only as a friend?.

The good thing is you can ride above your temperament and self-esteem

Perfection is a Journey

If I had to understand everything about connecting people before I began, I never would have started Facebook.
~Mark Zuckerberg FOUNDER OF FACEBOOK

In this article Mark Zuckerberg: ‘The idea of a single eureka moment is a dangerous lie’ he the founder of Facebook stated that

It can be tempting to believe that change-makers whose work affects generations must be extraordinary prodigies; that each one has a remarkable “a-ha” moment when a brainstorm is suddenly transmuted into a single, brilliant idea, obvious in its genius.

I think now is the right time to remove such a mindset and give it a rethink.
For me, perfection is determined by your legacy and what you're remembered for. It is usually after you're dead and long gone that your work can be qualified as being 'perfect'.

Think of:

The benefits of what you're about to initiate
How many positive outcomes it brings about when it succeeds
The people that will connect the dots and pick up from where you're likely going to stop.

Your conclusion should come only after the outcome of your action

Consciously and unconsciously our parents passed down the gene of playing it safe because it's the working prototype of life and anything other than that can turn out to be catastrophic.

In Africa when you deviate from the norm you're seen as strong-headed, ignorant, inexperienced, foolish.
An adage in my tribe (Igala, a tribe in Kogi state, north-central of Nigeria) goes this way "Akamagbo onwu chuku imoto" which literally translates to "Death comes to a child that does not hearken" talking based on their personal experiences with failure and how you should play it safe.

Unfortunately, this has been integrated into our societal cultures and is now the default amongst us, so we often draw conclusions before we even start.
Tony Cletus the head of Marketing at Happierco said something that struck home.

Why not give it a shot, you can always revert to the default

Leave the conclusion to be the Job of the outcome.

Rejections are Inevitable feedbacks you get in Life

What's the worst that can happen? you get a NO as a reply, the situation doesn't turn out as expected. Just so you know, this is normal in life.

Every now and then we celebrate successful people and their achievements but seldom talk about their processes, rejections, and failures. Elon Musk the CEO and founder of Tesla (electric cars), SpaceX (rocket technology), SolarCity ( energy services), amongst others is the top trend of celebration on his achievement as the World's richest man after surpassing Jeff Bezos (Amazon Boss) as of this writing.

Elon Musk Tweeted on his Twitter handle on his fair share of rejection along the way.

Elon Musk

@elonmusk

@wintonARK During the darkest days of the Model 3 program, I reached out to Tim Cook to discuss the possibility of Apple acquiring Tesla (for 1/10 of our current value). He refused to take the meeting.

20:46 PM - 22 Dec 2020

The Feedback he got after rejected by apple IMO was there was no better person to achieve the Tesla dream than himself. Sometimes we're rejected based on wrong perceptions of us, other times rejections are feedback for growth. Either way after a short feeling of disappointment (this is normal due to our human nature), convert it to a growth process and challenge yourself to achieve more.

Rejections always happen, sometimes we anticipate it other times it takes us by surprise (This always hits harder). This can be an opportunity to take out time to:

Cool off
Reach out to supportive people
Improve and
Re-energise your self-esteem

Farmers who wait for perfect weather never plant. If they watch every cloud, they never harvest.

Make that Proposal
Apply For that Job
Start that project
Make that request and keep requesting

Further reading suggestion

What Are You Asking For?

Fvck Imposter Syndrome!

Please Like and also share if you found this article useful.

Browser Console, JavasScript Quick Playground

Ojay — Thu, 21 May 2020 14:35:16 +0000

As a newbie in JavaScript one issue has always been to do a quick run on a snippet of JavaScript syntax, object, function, method, etc. The list goes and not properly informed there is this temptation to create a mini Vanilla project, create an HTML file alongside with a JS file and accompanied with the usual getElementById to represent your JavaScript result on the DOM. This was my struggle and the struggle of several JavaScript newbies.

Prerequisite
What is a Browser console?
Using a Browser Console
Conclusion.

Prerequisite

As a newbie you really shouldn't be bordered about prior Knowledge for using the console as a playground for your JavaScript code even if you just started with JavaScript 30mins ago 😉.

What is a Browser Console?

A Browser Console is a component of the browser that gives access but not limited to information associated with a web page such as

Network requests
JavaScript, CSS, security errors
Error, warning and informational messages explicitly logged by JavaScript code running in the page context
Write a snippet of JavaScript code and see the instant result. It also enables you to interact with a web page by executing JavaScript expressions in the context of the page. Most times your errors always come under the console, when you use console.log or any of the console equivalent methods.

For the purpose of this article, we would be looking at how to leverage the Console as a REPL (read–eval–print loop) i.e write snippet JavaScript code and see the instant result then repeat.

Using a Browser Console

When you want to do a quick play with JavaScript code, it is as easy as launching a browser, open the console, and start playing.

Launching the console

You can launch the console when in your chrome browser like this, go to the three vertical dot menu > more tools > developer tools> finally select the console tab. An easier shortcut is to press the Ctrl+Shift+I (or ⌘+shift+I on a mac) from the keyboard. Note that this process is almost similar across major browser platforms with the exception of some like firefox.

For Firefox from the Web Developer submenu in the Firefox Menu (or Tools menu if you display the menu bar or are on macOS), select "Browser Console". An easier shortcut is to press the Ctrl+Shift+J (or ⌘+Shift+J on a Mac) from the keyboard.

Using the console History and code suggestion

Playing around with a long snippet of code could get all tiring as it can't be compared to using an actual Text Editor or IDE for writing code. The good news is it suggests syntax just like most Text editor so you don't have to type for long.

A slight error can cause you to lose a large could you have been typing another good news is consoles support history just like a terminal using up and down arrow key from the keyboard. These histories are consistent even after you close the browser and re-open it.
To clear the console right-click in the console and select clear console history.

Finally, you can clear whatsoever mess you have in the console using clear() command or press Ctrl+L from the Keyboard.

Conclusion

The browser console can be a great tool in improving your skill as a JavaScript Developer, it can be of help to test JavaScript syntax (ES5, ES6, etc.), functions, methods, concepts (Hoisting, block scope, etc.), the list goes on.

As a beginner writing your short JavaScript codes in the Console REPL can be a big win in the long run as you get to demo what you just learn from an article without going through the process of opening a text editor or an IDE, test a function to see the result before inputting it into your large codebase, test or practice challenges to improve your skills on data structures and algorithms.

DEV Community: Ojay

Enforcing Git Branch Naming Standards: Tools and Tips for Developers

Introduction

Why Branch Naming Matters

A Simple Naming Convention

Examples of Common Branch Types

Narrowing Down Features

Enforcing the Convention

Conclusion

Enforcing Git Branch Naming Standards: Tools and Tips for Developers

Introduction

Why Branch Naming Matters

A Simple Naming Convention

Examples of Common Branch Types

Narrowing Down Features

Enforcing the Convention

Conclusion

My Journey as a Backend Developer: Tackling Complex Problems and Embracing the HNG Internship

The Challenge: Optimizing Database Performance

Step-by-Step Solution

1. Identifying the Bottleneck

2. Analyzing and Optimizing Queries

3. Implementing Caching

4. Database Sharding

Lessons Learned

Embarking on the HNG Internship

Conclusion

I failed a coding Interview 😞

What Software organisations mean by Development, Testing, Staging, and Production environments

Development Environment

Test or QA (Quality Assurance) Environment

Staging Environment

Production Environment

Stop Thinking Plenty Before You Act (The Analysis Paralysis Syndrome)

You can ride above your Temperament and self-esteem

Perfection is a Journey

Your conclusion should come only after the outcome of your action

Rejections are Inevitable feedbacks you get in Life

Browser Console, JavasScript Quick Playground

Table of Contents

Prerequisite

What is a Browser Console?

Using a Browser Console

Launching the console

Using the console History and code suggestion

Conclusion