Coming soon - Get a detailed view of why an account is flagged as spam!
view details
18
Last day at a summer job. What should I do to the codebase before I leave?
Post Body

Basically, they had me head a project where I worked solo 95% of the time (the 5% were when I couldn't figure something else and asked a senior guy to show me how to do stuff, so a couple features he wrote the barebones of it for and explained to me why he did what, etc).

Considering I have all of the code and had complete control, I want to just check what I should do before I leave it for the guy who takes over.

  • Commit everything, obviously. Make sure every file and linked file gets pushed so it's compile-ready.

  • Go over my naming conventions. They have their own way they do it here and I need to make sure it makes sense for the next person and follows it.

  • Comment, but I'm not sure what. They have a philosophy here of "If it needed to be commented, you didn't write it clear enough to begin with". So I only have commented things that don't make sense by name (like inline comments on calculations or things that are more precise then a 4-5 word name could explain). What should I make sure is commented? When you take over a project from a junior, what do you always go "I wish he explained x better"?

So other then that, I'm really not sure what to do. I feel this app is ready for the customers as there is little-to-no changes that need to be made (boss went over it three days ago and gave me the to-change checklist, which I completed). I just am worried the next guy will not understand something and feel rewriting it would be better then understanding what I did, so I want to make it clear enough for them.

Author
Account Strength
100%
Account Age
12 years
Verified Email
Yes
Verified Flair
No
Total Karma
47,706
Link Karma
3,451
Comment Karma
44,141
Profile updated: 6 days ago
Posts updated: 10 months ago
Student / Junior Developer

Subreddit

Post Details

We try to extract some basic information from the post title. This is not always successful or accurate, please use your best judgement and compare these values to the post title and body for confirmation.
Posted
9 years ago