Things you may want to cover:
-
Ruby version ( 3.0.1 )
-
How to run the test suite just run it
rspec
-
Deployment instructions
-
Install all the necessary gems with
bundle install
-
install overcommit
overcommit --install
-
sign overcommit
overcommit --sign
-
Start your web server with
rails server
- if your write code Ruby against rubocop pre-commit reject commit until fix Rubocop
- when push on project with code against unit test pre-push will reject pushing app