-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
code review Practice on Trial Project #1
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @Benawi ,
Good job so far!
There are some issues that you still need to work on to go to the next project but you are almost there!
Highlights
- Nice job adding comments requesting changes in the project 👏
- Good job using emojis and gifs, it makes your code review more human-friendly 🥇
Required Changes ♻️
-
Please, use inline comments so that the student can easily understand the context of your comments. Kindly, read about How to use Github features or watch this video with an example for more information.
-
Kindly always provide a "Why" for requesting changes. This always helps the students understand why a specific change is requested. Eg, adding a why for requesting the student to ensure that the linters are set up correctly would be something like, "Having linters correctly set up in your project will help ensure that the quality of your written code is good". This way, it is clear why having linters correctly set up benefits them.
-
Please always phrase your comments politely, as suggestions instead of orders. An example of a polite comment asking the student to add a description to the PR would be something like, "Please add a summary describing in more detail the changes introduced. This will help other developers know what to expect from your project."
-
Please checks the code to look for errors and bugs and leave nice comments containing change suggestions for each. Examples of issues the student may when performing the review:
- Lack of semantic HTML tags use.
- Not applying HTML & CSS best practices correclty.
- Bugs missed the first time the project was built.
- etc
Optional suggestions
Every comment with the [OPTIONAL] prefix is not crucial enough to stop the approval of this PR. However, I strongly recommend you to take them into account as they can make your code better.
Cheers and Happy coding!👏👏👏
Feel free to leave any questions or comments in the PR thread if something is not 100% clear.
Please, remember to tag me in your question so I can receive the notification.
Please, do not open a new Pull Request for re-reviews. You should use the same Pull Request submitted for the first review, either valid or invalid unless it is requested otherwise.
As described in the Code reviews limits policy you have a limited number of reviews per project (check the exact number in your Dashboard). If you think that the code review was not fair, you can request a second opinion using this form.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes done ♻️
- Inline comments is given in index.html and styles.css files
- Kindly I suggest "Why" for requesting changes.
- comments phrased politely
<li><b> 1945</b> - Discovers a way to grown wheat twice each season, doubling wheat yields | ||
</li> | ||
</ul> | ||
</section> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add footer section and add contact links to make easy for the user who wants to contac.
<figcaption id="img-caption">Dr. Norman Borlaug, third from the left, trains biologists in Mexico on how to increase wheat yields - part of his life-long war on hunger</figcaption> | ||
</figure> | ||
<section> | ||
<h2 id="tribute-info">Here's a time line of Dr. Borlaug's life: </h2> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest you to use standard HTML tags like div semantic HTML tags use.
integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous"> | ||
</head> | ||
|
||
<body> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest to use html 5 applying this makes your page attractive HTML & CSS best practices correclty.
@import url("https://fonts.googleapis.com/css2?family=Lato:wght@400;700&display=swap"); | ||
|
||
body { | ||
margin: 0; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please try to apply HTML & CSS best practices correclty.
@@ -0,0 +1,50 @@ | |||
@import url("https://fonts.googleapis.com/css2?family=Lato:wght@400;700&display=swap"); | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Your project has html and css linters error, Having linters correctly set up in your project will help ensure that the quality of your written code is good
Hi @Benawi, This is Adnan Is-haq, your beloved code reviewer, Your project is complete! There is nothing else to say other than... it's time to merge it Highlights
Optional suggestions
Every comment with the [OPTIONAL] prefix won't stop the approval of this PR. However, I strongly recommend you to take them into account as they can make your code better. Some of them were simply missed by the previous reviewer and addressing them will really improve your application. Cheers and Happy coding!👏👏👏 Feel free to leave any questions or comments in the PR thread if something is not 100% clear. As described in the Code reviews limits policy you have a limited number of reviews per project (check the exact number in your Dashboard). If you think that the code review was not fair, you can request a second opinion using this form. |
Comments given by @Benawi , When I acts as a code reviewer
Good job so far!
There are some issues that you still need to work on to go to the next project but you are almost there!
Linters are working not properly
Required Changes ♻️
please make a change the following line in your css file to make free from css and html linters error
37:1 ✖ Expected empty line before rule rule-empty-line-before
40:1 ✖ Expected empty line before rule rule-empty-line-before
43:1 ✖ Expected empty line before rule rule-empty-line-before
47:1 ✖ Expected empty line before rule rule-empty-line-before
50:1 ✖ Unexpected missing end-of-source newline no-missing-end-of-source-newline
You did a wonderful job implementing the required features👍, but it is required that
Kindly add 1-3 potential features to your project. 🥺 This can be:
Kindly make use of a descriptive pull request title so as to tell the reviewer about what changes are inside the request 🥺 😊