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 code (first-timers-only) #50

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.

There's a good opportunity to simplify one of our tests:

In src/Bid.test.ts when bidParams is defined we give it a value (a new BidParams object). But that value is immediately overwritten in the beforeEach function. Change the code so that bidParams is just defined, and isn't immediately assigned a value. While we're at it, and since this is TypeScript, give it a type of BidParams.

bidparams

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 😄

davarie commented 5 years ago

I would like to work on this if it's still up for grabs.

Thanks.

TalAter commented 5 years ago

Go ahead @davarie Thank you 👍

siddharth-mourya commented 5 years ago

I would like to work on it if still it is available.

davarie commented 5 years ago

Hi @TalAter,

Sorry for the dalay, I've now pushed the changes to origin master after making sure the tests still passed:

Test Suites: 17 passed, 17 total Tests: 21 skipped, 100 passed, 121 total Snapshots: 0 total Time: 17.604s Ran all test suites. [14:27:43] Finished 'jest' after 18 s [14:27:43] Starting 'prepublish'... [14:27:43] Finished 'prepublish' after 23 Ξs Counting objects: 4, done. Delta compression using up to 4 threads. Compressing objects: 100% (4/4), done. Writing objects: 100% (4/4), 435 bytes | 435.00 KiB/s, done. Total 4 (delta 3), reused 0 (delta 0) remote: Resolving deltas: 100% (3/3), completed with 3 local objects. To github.com:davarie/dav-js.git 1ddc031..47474b7 master -> master Branch 'master' set up to track remote branch 'master' from 'origin'.

TalAter commented 5 years ago

@davarie I don't see a pull request. Did you create one?

davarie commented 5 years ago

@TalAter my apologies, I've created it now after reading a few guides.

Sorry, the whole process is still a bit new to me, please let me know if I need to alter anything in the pull request.

Thanks.

TalAter commented 5 years ago

Looks great!

Thank you and congratulations on your first pull request!

davarie__davarie_

I hope it is the first of many contributions to open source, now that you've had a taste of it 👍

davarie commented 5 years ago

Thanks :) it's definitely something I hope to continuously contribute to going forward.