A template for a code hospitable README

README.md

Code Hospitality Guide App

This app helps you transform your team and codebase into code hospitable entities.

Installation

• Go to the Code Hospitality homepage
• Click the 'DOWNLOAD RIGHT NOW' button
• Twiddle thumbs
• Enjoy

Usage

• Read the Guide every day for at least 2 hours each day
• That is all

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-suggestion
3. Commit your changes: git commit -am 'Add some awesome suggestions'
4. Push to the branch: git push origin my-new-suggestion
5. Submit a pull request :D

History

• Nadia sat down one day and wrote this in one sitting

Approaches

• Service Objects
  • A brief description of what service objects are
• Domain Driven Design
  • Some words on how great DDD is

Reading material

• Service Objects Are Pretty Neat
• Rails & Service Objects
• Why DDD Is The Best Thing Ever
• Some blog post Nadia wrote on DDD

Walkthroughs

• Service Object Walkthrough — make_bed.rb
  • Here is the original feature request
  • This is the spec that was written
  • Here's the code that fixed that spec
  • And then we refactored it

Credits

TODO: Write credits

License

TODO: Write license