Skip to content

Task Release1

caracciolo edited this page Nov 5, 2014 · 2 revisions

1. Code: Release

At this point of the project you deliver your shippable product to the customer. The release must be of quality.

Make sure that:

  • **Tag the release in the repository with `v1.0`**.
    
  • Documentation for the domain model exists and is helpful, concise, correct.
    
  • The documentation is up-to-date.
    
  • You have a sufficiently wide set of test cases. 
    
  • The code should be easy to read, understand and maintain. This includes a consistent coding style and meaningful naming.
    
  • The repository is clean, that is, there are no unnecessary files, such as logs, notes, etc.
    
  • If needed, provide demo data and accounts to test the application (user/pwd: **ese/ese**).
    
  • Fix known bugs.
    
  • The website must run correctly on Chrome and Firefox.
    

As a rule of thumb you should deliver the project as if you would hand it over to maintainers that were not part of your team:

  Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live.
  —Rick Osborne

Happy release!

Clone this wiki locally