Skip to main content

Posts

Showing posts with the label Software practices

Golden debugging practices for a software developer

Debugging is really a hard and challenging phase in software development. It needs to be taken care and can be a highly sellable skill if you are good in debugging. Days would come where you should have mental skills to tackle the questions thrown by bugs. Let's have a look at some of the techniques in debugging right from the basic level. Don't Panic Be it at your desk or at a quality analyst's cabin or even when reading the mail of the bug raised, key idea is not to panic. There will be moments of critical issues being reported in a difficult time of a milestone. One should overcome the mental fights and focus on what the issue is. Give importance to key details Now you are in the place of a crime scene. You are investigating the crime scene. So take note of every available details in the console, the behavior, debug logs if any, etc. Get back to your desk and analyze the data you collected. You might have some thoughts right away if you are lucky. Don...

Object oriented SDK development

If you are someone who is into object oriented SDK development and looking for some best practices on API design, I have got you covered here. I have used C++ as the base to explain the core. OpenCV is one of the frameworks I have come across that does an exceptional job in providing classic and productive APIs in C++. Let's not waste time an quickly jump into the best practices of object oriented API design. Design easy-to-read API names First and foremost thing to consider in an object oriented SDK is the API name itself. Your API names should reveal everything. Keeping APIs as small as possible can be a difficult task but that is what you should deliver. The API should do what the name says. Nothing more. Nothing less.  Write your headers and review it Before you jump into development, it is important to code what the user wants. To have a crosscheck on that, write a header file(.h or .hpp) containing the public/private functions and data members. In this process, ...

Git commit best practices for beginners

                 If you are a recent college grad, you are going to use version control systems like git, mercurial day in and day out as you progress through your career. So I thought I can share you some knowledge about using git commit and its best practices. Treat commits religiously   Every git commit you do is basically a track of the progress of the product. A git commit should basically contain a feature or a bug fix. So commits like " changed a to b ", " Removing div element. " is not really a progress. Going forward you will need more commits like "ABC class added", "XYZ Function Implemented" , etc. Avoid repeated/duplicate commits Sometimes, without your knowledge, you would tend to commit a change multiple times. So it is always good to crosscheck the logs using git log before you push.  Test before you push This is mainly because the changes you made could affect any other feature. So b efore ...