DAVFoundation / dav-js

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

Remove unneeded code for messageParams (first-timers-only) #41

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 messageParams is defined we give it a value (a new MessageParams object). But that value is immediately overwritten in the beforeEach function. Change the code so that messageParams 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 MessageParams.

messageparams

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 😄

srfrnk commented 5 years ago

Can we hold this task for now? It is a bad practice to use global scope in tests. The code you are about to remove is what should remain. The global code should be deleted.

devkant commented 5 years ago

So should i leave this task?

TalAter commented 5 years ago

Closing for now. Will discuss with @srfrnk

TalAter commented 5 years ago

@devkant We had a discussion on this, and decided to go ahead with this one 👍 Are you still interested in doing it?

joseouluis commented 5 years ago

Can I take this?

TalAter commented 5 years ago

@joseluisbsa Thank you, but these issues are created specifically for people who would like to try open source for the first time. It actually takes a lot of work to create these issues, and I would like to give a chance to someone who hasn't contributed yet to try them, and become hooked on open source like you have 😃

But please, feel free to take any of the other issues not marked as first-timers-only or better yet... if you find any additions to the codebase which you believe are worthwhile, suggest something new 👍