From e73278088b714e0e85253bd920a21c2fc4fb3803 Mon Sep 17 00:00:00 2001 From: Ari Timonen Date: Sun, 15 Nov 2020 04:58:28 +0200 Subject: [PATCH] Update docs --- DEVELOPMENT.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index ec8d8a1..1185488 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -37,6 +37,12 @@ Run some tests: docker-compose exec -u web test bundle exec rspec` docker-compose exec -u web test bundle exec rspec spec/controllers/shoutmsgs_controller_spec.rb` +## Debugging + +Enable debug: +1. For tests, Make sure ``require 'pry-byebug'`` is uncommented at spec_helper.rb +1. Uncomment add `byebug` anywhere + ## Unresolved issues for development There are some unresolved issues to setup dev env. @@ -94,7 +100,11 @@ Read this to understand design decisions and follow them! ## Tags in code -FIXME, TODO, EXPLAIN, OBSOLETE +* ``FIXME`` bugs or bad coding that need to fixed one day +* ``TODO`` for things that are left undone +* ``EXPLAIN`` please explain what the following code does +* ``OBSOLETE`` remove this at some point +* ``DEBUG`` uncomment following lines to enable debug ## TODO issues for dev