Because

Bad "commit message"

Bad "naming"

Fix naming again?

Bad "coding style"

The difference between project and project?

frequently, got questions

• How to find the "solr" server?
• What's dev/staging site?
• How to find "design" files of this project?
• Who worked on this project?
• and many other question?

Why Have a Coding Standard?

• Improved code maintainability
• Improved code quality
• Improved development speed
• Better teamwork
• Make it quicker and easier for a developer to move to a different project or team.
• Better performance under pressure
• Fewer bugs
• The coding standard should be a living document

Why Perform Code Reviews?

• Find and fix defects early.
• Code review often proves more cost effective than testing.
• Good mentoring/training/learning/team building, especially for new hires.
• Improve overall quality of the code.

proposed coding standard & Best practices

• Coding Standard
• Checklist
• Internal Workflow

https://go1web.atlassian.net/wiki/display/GVN/Coding+standards%2C+security+and+best+practices

Why project documentation is important?

• You will be using your code in 6 months
• You want people to use your code
• You want people yo help out
• It makes your code better
• You want to be a better writer

PROPOSED Project Documentation

• Design Handover Document
  • https://www.yammer.com/go1.com.au/#/uploaded_files/20622005?threadId=411394012
• Prosposal
• Scoping Document 
  • https://go1web.atlassian.net/secure/attachment/24298/Eye%20Lighting%20BRS%20v1.1.pdf
• Development Handover Document
• Checklist
• Documentation
• Delivery Plan and Tracking Task
• Eg: https://go1web.atlassian.net/wiki/display/EL