Skip to main content

Documentation

Documenting everything is extremely important. It gives everyone the information they need whenever they need it. Github makes it very easy to have beautiful pages written in markdown rendered automatically. It's nice and easy to do. Creating a README in the root of the project is common practice and is even automatically rendered when the project is open in Github, under all the file names. I've been looking at quite a few different projects and they all have README files. It usually includes an introduction to the project, how to set it up, how to run it, how to contribute to it, major credits to people, etc... Essentially, it holds important information about the project that anyone has access to.

Along with the README file, we can comment on our actual code so hackers who read the code can know what does what. It allows the creator to recall what they wrote in the past and it invites new people to understand what has been written. It is really important that comments are written. It doesn't affect the softwares performance at all, but it makes it more professional and inviting for others to work on it. You can never have enough information.

Comments

Popular posts from this blog

My Journey of Fixing Bugs...Again

Last week, I left comments asking to be assigned to bugs in Thimble. I was excited to get started but I was informed that the bugs were already taken. And the worst part is that the person who was assigned is a fellow class member. I didn't know if I should be disappointed or happy for him. Anyways, as soon as I found out that none of my bugs were going to be assigned to me, I started commenting on other projects like Balrog, and I managed to land three bugs! Two in Balrog and one in network-pulse-api. I want to work on Balrog first. At first I was having a lot of trouble trying to build the Balrog project. I was running into errors and I kept figuring out how to fix them and I just couldn't get passed one. I was searching for days, i was just staring and not getting anywhere at one point. Finally, I decided to ask my teacher for help and he simply said, talk on IRC. I was a little skeptical but I did what he said and I was greeted and helped within minutes. The guy helpi