Skip to content

Instantly share code, notes, and snippets.

@vishal-keshav
Created January 15, 2019 17:06
Show Gist options
  • Save vishal-keshav/d84f288fc45775a5a76a7319495838f8 to your computer and use it in GitHub Desktop.
Save vishal-keshav/d84f288fc45775a5a76a7319495838f8 to your computer and use it in GitHub Desktop.
Importance of writing a good piece of code

To start anything, we should have a plan. And to execute the plan, we should have a system in place. However, sometimes we start with a plan but we find ourselves in a mess after a while. This mess happens not because our plan was bad, it was because we did not have a system in place that could have helped in easy execution of the tasks.

The same is true with software engineering or working on a research project. For example, suppose we want to work in an area and want to publish something. We create a plan, that includes reading several papers, experimenting with the idea, changing it and coming up with a new idea, experimenting with it and then publishing the good results. The plan is fantastic, but the ground reality is that it will almost always never work unless we have figured out a system to execute is easy. Here, the system would be to gain enough knowledge before reading a paper, setting up the code base where we want to experiment, determining our criteria of a “good” result, and figuring out a method to publish the results. If any of these is missing, the whole plan execution will go for a toss.

So, what to do? Create a solid system that may help not only to enact on an ongoing task according to a plan but making future tasks easy to handle. Care about creating a systematic approach before working on something.

Specifically, while implementing something, do these:

  1. Follow best design practices
  2. Comment the code that creates a good documentation
  3. Name the variable, classes, methods properly
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment