SlideShare a Scribd company logo
PROJECT	README	
by	Igor	Dominiak	from	@netguru
WHY	SHOULD	I	CARE?
WHAT	README	SHOULD	CONTAIN?
STRUCTURE
1.	 General	informations
2.	 Technologies
3.	 Setup
4.	 Development
5.	 Tests
6.	 Common	problems/bugs
7.	 Access	to	staging/beta/production
8.	 Notes
GENERAL	INFORMATIONS
Project	name	and	description
Badges	-	shield.io
Codeclimate
Coverage
CircleCi	Build
TECHNOLOGIES
Ruby/Rails	versions
Database
Patterns
Other
Redis
Solr/Sphinx/Elasticsearch
SETUP
Libraries	-	ImageMagick
Applications	-	Redis/Solr
Config	files	-	secrets/sec_config/.env
Database	-	PostgreSQL/MySQL/MongoDB
Other	services	-	Amazon/Stripe/Salesforce
SETUP	-	SEEDS
sample	data	for	main	models
seeds.rb	/	rake	tasks	/	seed-fu	+	faker
DEVELOPMENT
Additional	configuration
How	to	use
Example:	foreman/rubocop/gemsurance
TESTS
What	we	use	-	RSpec/Capybara/Cucumber
What	you	need	to	run	tests
How	run	tests	-	Guard
Javascript	tests
COMMON	PROBLEMS
Solutions	for	common	bugs	and	problems
ACCESS	TO	STAGING/BETA/PRODUCTION
How	I	can	get	access	-	passwords/ssh
NOTES
Code	style
Review	notes
Flow
Other
UPDATE	YOUR	README/SEEDS
THE	END

More Related Content

Similar to Perfect Project Read Me (in a few steps) (20)

PDF
Hands on Ruby on Rails
Salesforce Developers
 
PDF
Basic Rails Training
Arthit Hongchintakul
 
PDF
Assign, commit, and review - A developer’s guide to OpenStack contribution-20...
OpenCity Community
 
PPTX
Toolbox of a Ruby Team
Arto Artnik
 
PDF
Hosting Ruby Web Apps
Michael Reinsch
 
PDF
Assign, Commit, and Review
Zhongyue Luo
 
PPTX
Intro to Rails Give Camp Atlanta
Jason Noble
 
KEY
Ruby on Rails survival guide of an aged Java developer
gicappa
 
KEY
The story and tech of Read the Docs
ericholscher
 
PPTX
Apigee deploy grunt plugin.1.0
Diego Zuluaga
 
PDF
TorqueBox
bobmcwhirter
 
PDF
Web Development using Ruby on Rails
Avi Kedar
 
PDF
Leverage the power of Open Source in your company
Guillaume POTIER
 
KEY
An introduction to Rails 3
Blazing Cloud
 
PDF
Webinar: Continuous Deployment with MongoDB at Kitchensurfing
MongoDB
 
PDF
Ruby on Rails CMS - on the cloud
mpolakis
 
PPTX
Women Who Code - RSpec JSON API Workshop
Eddie Lau
 
PDF
Running trusted payloads with Nomad and Waypoint
Bram Vogelaar
 
PDF
Inside GitHub with Chris Wanstrath
SV Ruby on Rails Meetup
 
PPT
Rails Rookies Bootcamp - Blogger
Nathanial McConnell
 
Hands on Ruby on Rails
Salesforce Developers
 
Basic Rails Training
Arthit Hongchintakul
 
Assign, commit, and review - A developer’s guide to OpenStack contribution-20...
OpenCity Community
 
Toolbox of a Ruby Team
Arto Artnik
 
Hosting Ruby Web Apps
Michael Reinsch
 
Assign, Commit, and Review
Zhongyue Luo
 
Intro to Rails Give Camp Atlanta
Jason Noble
 
Ruby on Rails survival guide of an aged Java developer
gicappa
 
The story and tech of Read the Docs
ericholscher
 
Apigee deploy grunt plugin.1.0
Diego Zuluaga
 
TorqueBox
bobmcwhirter
 
Web Development using Ruby on Rails
Avi Kedar
 
Leverage the power of Open Source in your company
Guillaume POTIER
 
An introduction to Rails 3
Blazing Cloud
 
Webinar: Continuous Deployment with MongoDB at Kitchensurfing
MongoDB
 
Ruby on Rails CMS - on the cloud
mpolakis
 
Women Who Code - RSpec JSON API Workshop
Eddie Lau
 
Running trusted payloads with Nomad and Waypoint
Bram Vogelaar
 
Inside GitHub with Chris Wanstrath
SV Ruby on Rails Meetup
 
Rails Rookies Bootcamp - Blogger
Nathanial McConnell
 

More from Netguru (20)

PDF
Payments integration: Stripe & Taxamo
Netguru
 
PDF
Hidden Gems in Swift
Netguru
 
PDF
KISS Augmented Reality
Netguru
 
PDF
Why Would A Programmer Fall In Love With SPA?
Netguru
 
PDF
Defining DSL (Domain Specific Language) using Ruby
Netguru
 
PDF
How To Build Great Relationships With Your Clients
Netguru
 
PDF
Agile Retrospectives
Netguru
 
PDF
Ruby Rails Overview
Netguru
 
PDF
From Birds To Bugs: Testowanie Z Pasją
Netguru
 
PDF
Communication With Clients Throughout The Project
Netguru
 
PDF
Everyday Rails
Netguru
 
PDF
Estimation myths debunked
Netguru
 
PDF
Programming Paradigms Which One Is The Best?
Netguru
 
PDF
Z 50 do 100 w ciągu roku Jak rekrutować w IT?
Netguru
 
PDF
Paradygmaty Programowania: Czy Istnieje Najlepszy?
Netguru
 
PDF
Czy Project Manger Musi Być Osobą Techniczną?
Netguru
 
PDF
CSS architecture: How To Write Clean & Scalable Code
Netguru
 
PDF
Ruby On Rails Intro
Netguru
 
PDF
The Git Basics
Netguru
 
PDF
From nil to guru: intro to Ruby on Rails
Netguru
 
Payments integration: Stripe & Taxamo
Netguru
 
Hidden Gems in Swift
Netguru
 
KISS Augmented Reality
Netguru
 
Why Would A Programmer Fall In Love With SPA?
Netguru
 
Defining DSL (Domain Specific Language) using Ruby
Netguru
 
How To Build Great Relationships With Your Clients
Netguru
 
Agile Retrospectives
Netguru
 
Ruby Rails Overview
Netguru
 
From Birds To Bugs: Testowanie Z Pasją
Netguru
 
Communication With Clients Throughout The Project
Netguru
 
Everyday Rails
Netguru
 
Estimation myths debunked
Netguru
 
Programming Paradigms Which One Is The Best?
Netguru
 
Z 50 do 100 w ciągu roku Jak rekrutować w IT?
Netguru
 
Paradygmaty Programowania: Czy Istnieje Najlepszy?
Netguru
 
Czy Project Manger Musi Być Osobą Techniczną?
Netguru
 
CSS architecture: How To Write Clean & Scalable Code
Netguru
 
Ruby On Rails Intro
Netguru
 
The Git Basics
Netguru
 
From nil to guru: intro to Ruby on Rails
Netguru
 
Ad

Recently uploaded (20)

PPTX
Agentforce World Tour Toronto '25 - Supercharge MuleSoft Development with Mod...
Alexandra N. Martinez
 
PDF
Bitkom eIDAS Summit | European Business Wallet: Use Cases, Macroeconomics, an...
Carsten Stoecker
 
DOCX
Python coding for beginners !! Start now!#
Rajni Bhardwaj Grover
 
PPTX
Wondershare Filmora Crack Free Download 2025
josanj305
 
PDF
“ONNX and Python to C++: State-of-the-art Graph Compilation,” a Presentation ...
Edge AI and Vision Alliance
 
PPTX
Digital Circuits, important subject in CS
contactparinay1
 
PDF
NLJUG Speaker academy 2025 - first session
Bert Jan Schrijver
 
PDF
Software Development Company Keene Systems, Inc (1).pdf
Custom Software Development Company | Keene Systems, Inc.
 
PDF
🚀 Let’s Build Our First Slack Workflow! 🔧.pdf
SanjeetMishra29
 
PDF
NASA A Researcher’s Guide to International Space Station : Earth Observations
Dr. PANKAJ DHUSSA
 
PDF
Dev Dives: Accelerating agentic automation with Autopilot for Everyone
UiPathCommunity
 
PDF
“Squinting Vision Pipelines: Detecting and Correcting Errors in Vision Models...
Edge AI and Vision Alliance
 
PPTX
Talbott's brief History of Computers for CollabDays Hamburg 2025
Talbott Crowell
 
PDF
Linux schedulers for fun and profit with SchedKit
Alessio Biancalana
 
PDF
Survival Models: Proper Scoring Rule and Stochastic Optimization with Competi...
Paris Women in Machine Learning and Data Science
 
PDF
[GDGoC FPTU] Spring 2025 Summary Slidess
minhtrietgect
 
PPTX
MuleSoft MCP Support (Model Context Protocol) and Use Case Demo
shyamraj55
 
PDF
Automating Feature Enrichment and Station Creation in Natural Gas Utility Net...
Safe Software
 
PDF
How do you fast track Agentic automation use cases discovery?
DianaGray10
 
PDF
Modern Decentralized Application Architectures.pdf
Kalema Edgar
 
Agentforce World Tour Toronto '25 - Supercharge MuleSoft Development with Mod...
Alexandra N. Martinez
 
Bitkom eIDAS Summit | European Business Wallet: Use Cases, Macroeconomics, an...
Carsten Stoecker
 
Python coding for beginners !! Start now!#
Rajni Bhardwaj Grover
 
Wondershare Filmora Crack Free Download 2025
josanj305
 
“ONNX and Python to C++: State-of-the-art Graph Compilation,” a Presentation ...
Edge AI and Vision Alliance
 
Digital Circuits, important subject in CS
contactparinay1
 
NLJUG Speaker academy 2025 - first session
Bert Jan Schrijver
 
Software Development Company Keene Systems, Inc (1).pdf
Custom Software Development Company | Keene Systems, Inc.
 
🚀 Let’s Build Our First Slack Workflow! 🔧.pdf
SanjeetMishra29
 
NASA A Researcher’s Guide to International Space Station : Earth Observations
Dr. PANKAJ DHUSSA
 
Dev Dives: Accelerating agentic automation with Autopilot for Everyone
UiPathCommunity
 
“Squinting Vision Pipelines: Detecting and Correcting Errors in Vision Models...
Edge AI and Vision Alliance
 
Talbott's brief History of Computers for CollabDays Hamburg 2025
Talbott Crowell
 
Linux schedulers for fun and profit with SchedKit
Alessio Biancalana
 
Survival Models: Proper Scoring Rule and Stochastic Optimization with Competi...
Paris Women in Machine Learning and Data Science
 
[GDGoC FPTU] Spring 2025 Summary Slidess
minhtrietgect
 
MuleSoft MCP Support (Model Context Protocol) and Use Case Demo
shyamraj55
 
Automating Feature Enrichment and Station Creation in Natural Gas Utility Net...
Safe Software
 
How do you fast track Agentic automation use cases discovery?
DianaGray10
 
Modern Decentralized Application Architectures.pdf
Kalema Edgar
 
Ad