Alan Turing's Legacy, Part VI

Alan Turing's Legacy, Part VI


I have spoken to my Lead and we have a plan going forwards.

We have streamlined the Django course - I am only going to do the first 5 modules.

That way I can focus on what is most relevant. But - here is the plan that he has given me in terms of getting to know my Codebase (why have I forgotten everything - 5 pm brain - omg).

  • Going through the Codebase and only focusing on the most important files.
  • I know what these are but of course these are highly confidential so I will put them in a notion doc instead. I have them written down in the back of my notebook. I will write them all down in a notion doc.
  • Going through those files and IDENTIFYING THE KEY FUNCTIONALITY - WHAT DOES THE CODE DO - WHAT IS THE PURPOSE OF EACH FUNCTION. WHAT IS THE CODE'S FUNCTION.

And then based upon this, I have some tasks

  • Go through the code and write comments in the code
  • As many comments in the code as I need
  • I do not necessarily need to push them - I can see how that goes
  • In addition to that, I WANT TO WRITE SOME DOCUMENTATION FOR THE CODE
  • AS IF I WAS APPROACHING THE CODE ANEW/AFRESH
  • WHAT DOES EACH FUNCTION DO/WHAT IS THE PURPOSE OF EACH FUNCTION?
And then we will work on the first task which is a task on fixing an existing bug - but anyway the first step is to understand the task here, please - THANK YOU.

Comments

Popular posts from this blog

Hello World

Yosemite

Two Lines of Thought, Makes Me Wonder What I'm Missing