Moodle documentation: documenting hacks and alterations

Moodle documentation: documenting hacks and alterations

by Trolling in the Deep -
Number of replies: 1

What is the best way to document hacks and code alterations?

I mean, if i added some functions, it is very much easy to just comment and put the parameters, return, its objective and all... If we altered the core and stuff like that, what is the best way to document them?

Average of ratings: -
In reply to Trolling in the Deep

Re: Moodle documentation: documenting hacks and alterations

by Tim Hunt -
Picture of Core developers Picture of Documentation writers Picture of Particularly helpful Moodlers Picture of Peer reviewers Picture of Plugin developers

Well, if at all possible don't do that.

If you really must do that, then use a good version control system (=== git) to track you changes.

Also, consider a commenting convention to mark the changes inline too.

Average of ratings: -