commenting code

[mileslucas]

As Dr. Frisch brought up, commenting is the key to great code. Eric has a lot of code and the pressure of having it finished for his dissercation means some of it is sloppy. We can go through his code, especially his executable scrips (in src/functions), and add comments and remove commented code that appears extraneous.

[ejangelico]

Miles do you think it best to have a branch for the commented code? This may make sense so that merges don't pick up comments as conflicts and such. Or shall we comment the master?

[mileslucas]

I have not ever worked on a collaborative project, but what I've seen and read before is that the master branch should be 'sacred' and always working. Any code that wants to be added to master needs to be made in a separate branch. Once that code is deemed ready, a pull request can be made on master. So yes, create a branch, comment everything, maybe do a commit for every file you get through. Then when you feel finished we can merge it to master.

…

On Mon, Jul 10, 2017 at 3:56 PM, ejangelico ***@***.***> wrote: Miles do you think it best to have a branch for the commented code? This may make sense so that merges don't pick up comments as conflicts and such. Or shall we comment the master? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#3 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ANckA3Rpu6Zy1kg2UH1pciOOZA7RiXqmks5sMo_1gaJpZM4OTWwQ> .