Skip to content
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

🏗️ Pop ✍️ up Comment window and Involvements 👍 #32

Merged
merged 44 commits into from
Nov 26, 2022

Conversation

Zia123456
Copy link
Collaborator

@Zia123456 Zia123456 commented Nov 26, 2022

🚧 ATTENTION 🚧

The falling checks are for the API key which we decided to expose for the Reviewer testing as advised by the previous reviewer.

I this PR We implemented the following:

  • Learn how to use proper ECMAScript syntax.
  • Use ECMAScript modules to write modular JavaScript.
  • Understand the benefits of modular architecture in JavaScript applications.
  • Use callbacks and promises.
  • Use webpack to bundle JavaScript.
  • Use npm as a package manager.
  • Use API documentation.
  • Send and receive data from an API.
  • Store confidential API-related information in a secure way.
  • Understand and use JSON.
  • Make JavaScript code asynchronous.
  • Describe the difference between async and sync calls.
  • Write unit tests for a JavaScript app.

Thanks for the review 🥂

@github-pages github-pages bot temporarily deployed to github-pages November 26, 2022 15:11 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 26, 2022 15:16 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 26, 2022 15:17 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 26, 2022 15:18 Inactive
Copy link

@zieeco zieeco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Team,

Great job so far! 👏
You've done well, however, there are some issues that you still need to work on to go to the next project, but you are almost there!

To highlight 🎯

  • No linter errors.✔️
  • Nice design. ✔️
  • Descriptive PR. ✔️

Required Changes ♻️

Check the comments under the review.

  • Kindly address those issues so that the next reviewer can review your project properly as all the issues I found made me not able to make appropriate review on the project. 🙏

Optional suggestions

  • N/A

Every comment with the [OPTIONAL] prefix won't stop the approval of this PR. However, I strongly recommend you 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.
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.

Comment on lines 1 to 2
/* eslint-disable import/no-unresolved */
/* eslint-disable operator-linebreak */
Copy link

@zieeco zieeco Nov 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

REMOVE ALL LINTER IN THE PROJECT AND FIX THEM

  • The linter disabled is way too much and it makes your codebase not clean and readable

  • Please, let's remove all the eslint disable command and fix the linter error to improve our abilities to write clean and maintainable codebases that conforms to the linter as this is widely used in software development to ensure good code quality.

@@ -0,0 +1,36 @@
/* eslint-disable import/no-unresolved */
/* eslint-disable operator-linebreak */
import { key } from './api-key.js';
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Hey team, I'm finding it difficult to run your app as I think the imported import { key } from './api-key.js'; does not exist in your codebase, Please, kindly double check as this is throwing an error and make your app not to run.
  • As a result of this, I can't make appropriate reviews on the project. Please, kindly fix this.

Screenshot from 2022-11-26 16-24-01

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We avoided pushing the API keys into GitHub for security purposes.
Set up instructions was included n the read me
@zieeco

Comment on lines 2 to 4
// import renderPopup from './popup.js';
/* eslint-disable camelcase */
// hold our api in a constant
// eslint-disable-next-line import/no-mutable-exports
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • As this is a JavaScript project, the naming convention used in JS is camelCase, so why not try following best practices than disabling the linter? Please, remove all the linter disabled commands and fix the issue.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted 🙂

Comment on lines 1 to 5
/* eslint-disable operator-linebreak */
/* eslint-disable consistent-return */
/* eslint-disable camelcase */
/* eslint-disable import/no-unresolved */
/* eslint-disable no-unused-vars */
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Hey Team, most of these linters are pretty easy to fix them. Please, let's try fixing them to make our codebase clean and maintainable.

NOTE: I understand that you're behind schedule for the submission of this project, however, if you can't fix it, kindly state the reason why you couldn't and the next reviewer would overlook it

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Implemented @zieeco

Comment on lines 1 to 2
/* eslint-disable consistent-return */
/* eslint-disable no-useless-concat */
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Please, let's try and fix the linter to improve our ability on writing clean readable code.

Comment on lines 3 to 4
/* eslint-disable import/no-unresolved */
import { API_KEY } from './api-key.js';
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • You disabled the linter here because eslint can't find this import { API_KEY } from './api-key.js'; anywhere is the directories/files. please, kindly check if it exists to fix the linter error.

README.md Outdated
@@ -15,7 +15,6 @@
- Webpack
- Jest - for Unit Testing.

#### [Live link](https://simongideon.github.io/javascript-group-capstone-project/)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[REQUIRED CHANGES ON README FILE]

  • Hey, great job with your readme, however, the microverse readme template has been updated to this current version. Do kindly update your readme to conform to these changes and also, customize it to suit your current project.

  • Great job adding the live demo version but kindly note that you're deployment is not showing your project. You can try using netlify to deploy the app. I addition, you're yet to add a video presentation as this is a core requirement to have your project approved. please, refer to the project requirement to add this missing part of the requirement.
  • You should also add the link to the video just like the live demo version

@github-pages github-pages bot temporarily deployed to github-pages November 26, 2022 17:11 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 26, 2022 17:15 Inactive
@gitguardian
Copy link

gitguardian bot commented Nov 26, 2022

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request
GitGuardian id Secret Commit Filename
5102819 Generic High Entropy Secret 820758f src/modules/api-key.js View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!

@github-pages github-pages bot temporarily deployed to github-pages November 26, 2022 17:16 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 26, 2022 17:21 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 26, 2022 17:47 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 26, 2022 17:50 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 26, 2022 18:02 Inactive
Copy link

@Ismailco Ismailco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Zia123456, @SimonGideon,

In my opinion, your project is ready for presentation! There is nothing else to say other than... it's time to merge it :shipit:

cr-approve

Highlights

✔️ No linter errors
✔️ Used Gitflow
✔️ Work documented professionally

Good luck! 🎉

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.

@@ -0,0 +1,24 @@
/* eslint-disable no-useless-concat */

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • [OPTIONAL] Please remove all the disabled linters and fix the linters for better practices and clean code, I will not require you to change them because you fixed the specifically pointed linters by the previous reviewer, this is the last review you have, and the deadline is near however I highly recommend fixing this linters instead of disabling them

@github-pages github-pages bot temporarily deployed to github-pages November 26, 2022 18:33 Inactive
@SimonGideon SimonGideon merged commit 62dc9cb into development Nov 26, 2022
@SimonGideon SimonGideon temporarily deployed to github-pages July 5, 2023 19:00 — with GitHub Pages Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment