second version st review guideline

README.md

@@ -27,7 +27,7 @@
     ![Where to write a solution](./assets/where-to-write-a-solution.png)
 1. Run `pytest` to check if your solution is correct (from command line, or using PyCharm `pytest` support)
     - If at least one test fails fix the solution and check again.
-1. Run `flake8 app` to see if your code follows the [flake8 rules](https://www.flake8rules.com/)
+1. Run `flake8` to see if your code follows the [flake8 rules](https://www.flake8rules.com/)
     - If you see some errors fix them and check again
 1. Save the solution
     ```

py-st-review/ST-REVIEW.md

@@ -1,5 +1,24 @@
 # Students review guideline
 
+### **Remember!**
+
+**It's okay if the code you are checking differs from your own code. The main thing is that all requirements are fulfilled.**
+
+## Student's review example
+
+1. Set status "o - on st review".                           
+    ![set_status_on_st_review](../assets/set_status_on_st_review.png)
+2. Check if the tests are passed.
+    ![all_tests_are_passed](../assets/all_tests_are_passed.png)
+3. We're reviewing work, following the checklist. If you find some mistakes, add the comment about this mistake.
+    ![start_review_code](../assets/start_review_code.png)
+4.  So we've found some incorrect variable names here. If incorrect name of variables are found, you should report this and ask for changes.
+    ![ending_of_review](../assets/inccorect_var_for_example.png)
+5. After fulfil checking by checklist, finish your review and by choose one of the variant (Request changes or Approve).
+    ![ending_of_review](../assets/ending_of_review.png)
+6. Check homework's status on the table.                               
+    ![check_status_in_table](../assets/check_status_in_table.png)
+
 ## How to use statuses
 
 1. When you send your homework, the status **"s - st review"** is assigned to it automatically, you don't need to set it by yourself. 
@@ -13,23 +32,16 @@
 
 1. The tests are passed.
 2. All task conditions are met if there are no tests in the task.
-3. The correct code spelling, by the recommendation on [PEP 8](https://peps.python.org/pep-0008/)
-4. Using best practices from lectures and videos.
-5. The correct name of the variables(classes, functions, etc.) and the absence of spelling errors. 
-6. Using DRY, SOLID, and other principles.
-7. Simple and correct description of the problem if you find one.
-8. Correct naming for commits.
-9. **IMPORTANT** Using [PEP 20 The Zen of Python](https://peps.python.org/pep-0020/)
+3. The correct code spelling, by the recommendation on [PEP 8](https://peps.python.org/pep-0008/).
+4. Using best practices from lectures and videos. Also using DRY and other principles.
+5. The correct name of the variables(classes, functions, etc.) and the absence of spelling errors.
+6. Correct naming for commits.
+7. **IMPORTANT** Simple is better than complex. Using [PEP 20 The Zen of Python](https://peps.python.org/pep-0020/).
 
-## Student's review example
+## Recommendation how to report an error
 
-1. Set status "o - on st review".                           
-    ![set_status_on_st_review](../assets/set_status_on_st_review.png)
-2. Check if the tests are passed.
-    ![all_tests_are_passed](../assets/all_tests_are_passed.png)
-3. If you find some mistakes, add the comment about this mistake.
-    ![start_review_code](../assets/start_review_code.png)
-4. After fulfil checking by checklist, finish your review and by choose one of the variant (Request changes or Approve).
-    ![ending_of_review](../assets/ending_of_review.png)
-5. Check homework's status on the table.                               
-    ![check_status_in_table](../assets/check_status_in_table.png)
+1. It's okay if you miss some errors, and the mentor has found them after your review. But remember, it will be good if you find them right now.
+2. Add simple and correct description of the problem if you find one.
+3. You should try to explain how to fix this error.
+4. If it's necessary, and you know the source, you can add link on solving this problem.
+5. When you are not sure if it's a problem or not, or you don't know how to explain it, you can always refer to the mentor in the chat to clarify this.