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

Implement _check #2107

Open
wants to merge 2 commits into
base: GANONTHA
Choose a base branch
from
Open

Implement _check #2107

wants to merge 2 commits into from

Conversation

GANONTHA
Copy link

@GANONTHA GANONTHA commented Dec 2, 2023

This is the summary of my contribution to the open source project

Basically I did two things. The first was to implement the fuhct _check to avoid repetitions in the code by removing all the redundant codes from different scopes and saving inside a single function. This allowed me to make the code DRY.
Next I touch a bit the test file so that the test runs. There were some typos in the test.

And also, I have installed some dependencies in order to run the code on me local machine.
I the end three (3) files have been changes:

1 -> calculator.js
2 -> calculator.test.js
3 -> package-lock.json

@dantharejabot
Copy link
Collaborator

Yay, a pull request!

After you submit a pull request, one of the following will happen:

😭 You don’t get a response. 😭

Even on an active project, it’s possible that your pull request won’t get an immediate response. You should expect some delay as most open source maintainers do so in their free time and can be busy with other tasks.

If you haven’t gotten a response in over a week, it’s fair to politely respond in the same thread, asking someone for a review. If you know the handle of the right person to review your pull request, you can @-mention them to send them a notification. Avoid reaching out to that person privately; remember that public communication is vital to open source projects.

If you make a polite bump and still nobody responds, it’s possible that nobody will respond, ever. It’s not a great feeling, but don’t let that discourage you. It’s happened to everyone! There are many possible reasons why you didn’t get a response, including personal circumstances that may be out of your control. Try to find another project or way to contribute. If anything, this is a good reason not to invest too much time in making a pull request before other community members are engaged and responsive.

🚧 You're asked to make changes to your pull request. 🚧

It’s very common that someone will request changes on your pull request, whether that’s feedback on the scope of your idea, or changes to your code. Often a pull request is just the start of the conversation.

When someone requests changes, be responsive. They’ve taken the time to review your pull request. Opening a PR and walking away is bad form. If you don’t know how to make changes, research the problem, then ask for help if you need it.

If you don’t have time to work on the issue anymore (for example, if the conversation has been going on for months, and your circumstances have changed), let the maintainer know so they’re not expecting a response. Someone else may be happy to take over.

👎 Your pull request doesn’t get accepted. 👎

It's possible your pull request may or may not be accepted in the end. If you’re not sure why it wasn’t accepted, it’s perfectly reasonable to ask the maintainer for feedback and clarification. Ultimately, however, you’ll need to respect that this is their decision. Don’t argue or get hostile. You’re always welcome to fork and work on your own version if you disagree!

🎉 Your pull request gets accepted and merged. 🎉

Hooray! You’ve successfully made an open source contribution!


Thank you for the submission, @GANONTHA! I'll review your code shortly, hang tight.

Copy link
Collaborator

@dantharejabot dantharejabot left a comment

Choose a reason for hiding this comment

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

This is a great attempt, @GANONTHA!

I would like to request a few changes before merging your work. Please review my comments below and make the appropriate changes to your code.

After you update your code locally, follow the instructions to save your changes locally and push your changes to your fork.

When you push your changes to your fork, I'll come back for another review.


There are 36 style guide violations in your contribution. I've marked them with inline comments for your convenience.

Please revisit your code and follow the style guide best practices.

Hint: You might be able to fix some issues automatically by running npm run lint -- --fix


All the tests are passing. Nice job!

// DRY up the codebase with this function
// First, move the duplicate error checking code here
if (typeof x !== "number") {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

if (typeof x !== "number") {
throw new TypeError(`${x} is not a number`);
}
if (typeof y !== "number") {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

@@ -1,20 +1,20 @@
/* eslint-disable no-unused-expressions */
const calculator = require('./calculator');
const calculator = require("./calculator");
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)


describe.skip('_check', () => {
describe("_check", () => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

beforeEach(() => {
sinon.spy(calculator, '_check');
sinon.spy(calculator, "_check");
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

describe('subtract', () => {
it('should throw a TypeError if arguments are not numbers', () => {
expect(() => calculator.subtract(40, '2')).to.throw(TypeError);
describe("subtract", () => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

it('should throw a TypeError if arguments are not numbers', () => {
expect(() => calculator.subtract(40, '2')).to.throw(TypeError);
describe("subtract", () => {
it("should throw a TypeError if arguments are not numbers", () => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

expect(() => calculator.subtract(40, '2')).to.throw(TypeError);
describe("subtract", () => {
it("should throw a TypeError if arguments are not numbers", () => {
expect(() => calculator.subtract(40, "2")).to.throw(TypeError);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

expect(() => calculator.subtract(40, [])).to.throw(TypeError);
expect(() => calculator.subtract(40, {})).to.throw(TypeError);
expect(() => calculator.subtract('40', 2)).to.throw(TypeError);
expect(() => calculator.subtract("40", 2)).to.throw(TypeError);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

expect(() => calculator.subtract([], 2)).to.throw(TypeError);
expect(() => calculator.subtract({}, 2)).to.throw(TypeError);
});

it('should subtract two positive numbers', () => {
it("should subtract two positive numbers", () => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

@dantharejabot
Copy link
Collaborator

✨ Changes synced ✨

When a pull request is open, GitHub tracks changes to the branch it was opened from. As you push changes to your fork's master branch, you'll automatically see them here.

Thanks for the changes, @GANONTHA. I'm reviewing them now.

Copy link
Collaborator

@dantharejabot dantharejabot left a comment

Choose a reason for hiding this comment

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

This is a great attempt, @GANONTHA!

I would like to request a few changes before merging your work. Please review my comments below and make the appropriate changes to your code.

After you update your code locally, follow the instructions to save your changes locally and push your changes to your fork.

When you push your changes to your fork, I'll come back for another review.


There are 36 style guide violations in your contribution. I've marked them with inline comments for your convenience.

Please revisit your code and follow the style guide best practices.

Hint: You might be able to fix some issues automatically by running npm run lint -- --fix


All the tests are passing. Nice job!

// DRY up the codebase with this function
// First, move the duplicate error checking code here
if (typeof x !== "number") {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

if (typeof x !== "number") {
throw new TypeError(`${x} is not a number`);
}
if (typeof y !== "number") {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

@@ -1,20 +1,20 @@
/* eslint-disable no-unused-expressions */
const calculator = require('./calculator');
const calculator = require("./calculator");
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)


describe.skip('_check', () => {
describe("_check", () => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

beforeEach(() => {
sinon.spy(calculator, '_check');
sinon.spy(calculator, "_check");
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

describe('subtract', () => {
it('should throw a TypeError if arguments are not numbers', () => {
expect(() => calculator.subtract(40, '2')).to.throw(TypeError);
describe("subtract", () => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

it('should throw a TypeError if arguments are not numbers', () => {
expect(() => calculator.subtract(40, '2')).to.throw(TypeError);
describe("subtract", () => {
it("should throw a TypeError if arguments are not numbers", () => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

expect(() => calculator.subtract(40, '2')).to.throw(TypeError);
describe("subtract", () => {
it("should throw a TypeError if arguments are not numbers", () => {
expect(() => calculator.subtract(40, "2")).to.throw(TypeError);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

expect(() => calculator.subtract(40, [])).to.throw(TypeError);
expect(() => calculator.subtract(40, {})).to.throw(TypeError);
expect(() => calculator.subtract('40', 2)).to.throw(TypeError);
expect(() => calculator.subtract("40", 2)).to.throw(TypeError);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

expect(() => calculator.subtract([], 2)).to.throw(TypeError);
expect(() => calculator.subtract({}, 2)).to.throw(TypeError);
});

it('should subtract two positive numbers', () => {
it("should subtract two positive numbers", () => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Strings must use singlequote.
(learn more)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants