I always try to keep in mind that someone else will eventually inherit whatever project I'm currently working on, accordingly:
Write easy to follow code: this is certainly a balancing act, you don't want to be needlessly verbose, but I've seen plenty of developers go too far in the other direction and write "clever" code that is short but much too difficult to unwind and understand.
Document just enough: you should cover things that are necessary for a new developer to get up to speed quickly, such as "how do I run this on my development machine?". I'm surprised at how often this type of information is left out. It's also a good idea to explain why certain design decisions were made in a project.
I've got more guiding principals than just these two, but I'd certainly appreciate it if others would consider adding these two to their own.
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
I always try to keep in mind that someone else will eventually inherit whatever project I'm currently working on, accordingly:
Write easy to follow code: this is certainly a balancing act, you don't want to be needlessly verbose, but I've seen plenty of developers go too far in the other direction and write "clever" code that is short but much too difficult to unwind and understand.
Document just enough: you should cover things that are necessary for a new developer to get up to speed quickly, such as "how do I run this on my development machine?". I'm surprised at how often this type of information is left out. It's also a good idea to explain why certain design decisions were made in a project.
I've got more guiding principals than just these two, but I'd certainly appreciate it if others would consider adding these two to their own.