[x] Think about the questions and discuss your answers with your teammate
[x] Write your answers to question 1:
Clean code is easier to read and modify, helping teams quickly understand and work on the project.
Good architecture supports modularity, making it easier to add or change features without disrupting the entire system.
``
[x] Write your answers to question 2:
Because of collaboration, other people should be able to continue the code from where it's left off
In industrial projects, after a while new developers would join the team, so they should be able to read old codes and maintain it
In industrial projects, frequent changes require flexible code. Clean code and good architecture allow for quick and safe modifications.
[x] Visit the mentioned links in the doc and read the article individually
[x] Think about the questions and discuss your answers with your teammate
[x] Write your answers to question 1:
Clean code is easy to read and maintain, reducing debugging time and costs.
Efficient code minimizes resource needs and ensures smooth performance.
Clean code shows professionalism and ensures a high-quality, reliable product.
[x] Write your answers to question 2:
In large-scale environments, software reliability is crucial to avoid costly disruptions and financial losses.
Clean code and good architecture minimizes risks
At an industrial scale, maintaining software is more complex and expensive. Clean code and good architecture help prevent costly failures and ensure smooth updates.
[x] Read about these famous code smells individually
[x] Long Method
[x] Primitive Obsession
[x] Large Class
[x] Long Parameter List
[x] Temporary Field
[x] Duplicate Code
Which code smells of above list exist in your search project?
long method, large class and primitive obsession
[x] Read about SOLID principles in software engineering:
[x] Single Responsibility
[x] Open-Close
[x] Liskov Substitution
[x] Interface Segregation
[x] Dependency Inversion
[x] Refactoring Techniques:
[x] Take a look at Refactoring Techniques
[x] Fix code smells you mentioned for your search project in a new branch
[x] Make a PR (Pull Request) from new branch to master but do not merge it
[x] Go back to your own PR and correct your code according to reviewers feedback (comments)
[x] After fixing all comments ask reviewers to approve your PR
[x] When the other team approved, ask your mentor to review your PR
[x] When you junior mentor approved, ask your senior to review your PR
[x] When they approved, you can merge your PR to master branch
For PR(s) you agreed to review:
[x] Ask PR owners to fix issues in their codes
[x] When they fixed them, review again and make sure each comment is resolved (by changing its status)
[x] If all comments are resolved or both teams agreed that fixing that comment is not necessary or doesn't worth to be fixed, approve PR and complete your review
[x] Clean Code Importance
Clean code is easier to read and modify, helping teams quickly understand and work on the project.Good architecture supports modularity, making it easier to add or change features without disrupting the entire system.Because of collaboration, other people should be able to continue the code from where it's left offIn industrial projects, after a while new developers would join the team, so they should be able to read old codes and maintain itIn industrial projects, frequent changes require flexible code. Clean code and good architecture allow for quick and safe modifications.Clean code is easy to read and maintain, reducing debugging time and costs.Efficient code minimizes resource needs and ensures smooth performance.Clean code shows professionalism and ensures a high-quality, reliable product.In large-scale environments, software reliability is crucial to avoid costly disruptions and financial losses.Clean code and good architecture minimizes risksAt an industrial scale, maintaining software is more complex and expensive. Clean code and good architecture help prevent costly failures and ensure smooth updates.[x] Read about these famous code smells individually
Which code smells of above list exist in your search project?
long method, large class and primitive obsession[x] Read about SOLID principles in software engineering:
[x] Refactoring Techniques:
[x] Make a PR (Pull Request) from new branch to master but do not merge it
https://github.com/Star-Academy/Summer1403-SE-Team06/pull/4
[x] Code Review:
[x] Request another team to Review your PR
[x] Read Review Guides
[x] While another team is reviewing your PR, you should also review their PR (or even find a third team and review their PR)
For your own PR:
[x] Go back to your own PR and correct your code according to reviewers feedback (comments)
[x] After fixing all comments ask reviewers to approve your PR
[x] When the other team approved, ask your mentor to review your PR
[x] When you junior mentor approved, ask your senior to review your PR
[x] When they approved, you can merge your PR to master branch
For PR(s) you agreed to review:
[x] Ask PR owners to fix issues in their codes
[x] When they fixed them, review again and make sure each comment is resolved (by changing its status)
[x] If all comments are resolved or both teams agreed that fixing that comment is not necessary or doesn't worth to be fixed, approve PR and complete your review
Congratulations! You are a great reviewer!