Adding more granular error reporting notes

zachroofsec · zachroofsec · commit d4106d4b4d29 · 2018-01-08T05:32:32.000-05:00
diff --git a/README.org b/README.org
@@ -24,24 +24,26 @@
    - To launch with ~node~ instead of ~nodemon~ simply prepend ~EXEC_MODE=node~
      to the ~docker-compose~ invocation
 6. The next steps will depend on the example in question
-   1. Please refer to a tutorial's ~README.org~ (or video)
+   1. Please refer to a tutorial's ~README.md~ (or video)
    2. For many examples, changes in your local environment will be automatically
       mapped into the docker container created via ~docker-compose~
       1. For example, if you make changes within a tutorial's directory locally,
          the container will automatically be restarted with those changes
 * Errors
-** The error is related to a tutorial's code/configs
-1. Find the tutorial within the root directory of this repo
-2. Submit a PR with the fix
-   1. Make a comment above your fix with a brief description of the change
-   2. Prepend ~FIXED-ERROR~ to this comment
-3. Please do a global search of the repo to see other areas that might have this error
-
 ** The error is NOT related to a tutorial's code/configs
-1. Find the tutorial within the root directory of this repo
-2. Within the repo's ~readme.md~, find the slide in question
+1. Find the tutorial's directory within this repo
+2. Review ~readme.md~ and find the slide with the error
 3. Add a ~FIXED-ERROR~ bullet under the problematic text
    - As a sub-bullet of ~FIXED-ERROR~, explain the correction
+4. Within the tutorial's ~readme.md~, update the ~Error Log~ section
+** The error is related to a tutorial's code/configs
+1. Find the tutorial's directory within this repo
+2. Find the erroneous file
+3. Submit a PR with the fix
+   1. Make a comment above your fix with a brief description of the change
+   2. Prepend ~FIXED-ERROR~ to this comment
+4. Within the tutorial's ~readme.md~, update the ~Error Log~ section
+5. Do a global search to find other areas that might have this error
 * Additional Help
 + Feel free to open an issue
 * TOS
