DAVFoundation / dav-js

Enable integration of JavaScript, TypeScript, and Node.js code with the DAV Network
https://developers.dav.network/
MIT License
76 stars 51 forks source link

Remove unneeded beforeAll calls from SDK test (first-timers-only) #45

Closed TalAter closed 5 years ago

TalAter commented 5 years ago

first-timers-only

This issue is tagged :octocat: first-timers-only. It is only for people who have never contributed to open source before, and are looking for an easy way take their first steps.

Consider this your chance to dip your toe into the world of open-source, and get some bragging rights for writing code that makes drones fly, lets cars find charging stations, helps people and goods get from place to place, and more.

Find more first-timers-only issues from DAV Foundation here.

Thank you for your help :heart:

What is this project?

DAV (Decentralized Autonomous Vehicles) is a new foundation working to build an open-source infrastructure for autonomous vehicles (cars, drones, trucks, robots, and all the service providers around them) to communicate and transact with each other over blockchain.

As an organization that believes in building a large community of open-source contributors, we often create issues like this one to help people take their first few steps into the world of open source.

dav-js

This repo contains the DAV JavaScript SDK. This SDK allows developers to build applications and servers that connect to the DAV network. For example, allowing a drone to find charging stations, or an autonomous car to ask for traffic data.

How you can help

In order to foster a community that is welcoming for open source contributions, it is important for us to have good test coverage. And good tests are simple, readable tests.

Here is a good opportunity to simplify one of our tests:

In src/SDK.test.ts there is an empty function: beforeAll(() => { /**/ });

This is code that does nothing and can be deleted.

empty_function

After making your changes, make sure the tests still pass by running npm run jest

Contributing to dav-js

Asking for help

We appreciate your effort in taking the time to work on this issue and help out the open source community and the foundation. If you need any help, feel free to ask below or in our gitter channel. We are always happy to help 😄

sark01 commented 5 years ago

Hi, Can I look into this?

TalAter commented 5 years ago

Go ahead @sark01 Thank you 👍

sark01 commented 5 years ago

Hi, I made the changes as mentioned in the task, but when I try to execute "npm run jest", I get errors. I have attached the npm debug log for reference. Please help. npm-debug.log

TalAter commented 5 years ago

@sark01 Did you execute npm run jest before making your changes as well? This will help you understand whether the tests failed because of the code you entered or is it unrelated?

I would clone the basic code again, run npm install and then npm run jest.

sark01 commented 5 years ago

@TalAter, I did not execute the npm run jest before making the changes previously.

To conclude, I feel the failure of the tests are not related to whatever code I wrote/removed.

Should I send in a PR?

TalAter commented 5 years ago

Did you get errors after running it for the first time before making your changes?

sark01 commented 5 years ago

Yes, Some of the tests were failing.

sark01 commented 5 years ago

Hi @TalAter, Today I again did a clean clone of the repository again and did npm install, and then did npm run jest, all the tests were passing. So I made the necessary changes and will send in a PR as soon as I'm done with it. Thanks.

TalAter commented 5 years ago

Thank you @sark01 👍 Looks great.

I'm glad the initial problems resolved themselves. I believe it had to do with some issues one of our developers just fixed.

Thanks again 😎

sark01 commented 5 years ago

Thanks @TalAter , are there any newcomer issues/ low difficulty issues I can work on?

TalAter commented 5 years ago

Sure. I just created #55. You want to give that a try?

sark01 commented 5 years ago

Sure thing.