Skip to content

subramanir2143/hacktoberfest-js-utils

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

76 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hacktoberfest 2018 JS Utils

Build Status

The point of this repository to build a suite of javascript methods by the time hacktoberfest ends! Let's get some T-shirts!
Original repo by @rgehan.

Installation

You first need to fork the repository, then clone it, go in the directory and run:

# Install the dependencies
yarn

How to participate

  1. Find an issue that is not assigned yet
  2. Implement it so that it passes all the tests (use yarn test src/[methodName].test.js to run the tests)
  3. Add a skeleton of a new method along with new test suite for it
  4. Now we have fixed a method, written the skeleton of a new one, and a test suite to accompany it, so we can push our changes and open a pull request.
  5. Create an issue for your new feature

Rules

  • Each PR should contain 3 files: implementation of the method you've been assigned to, a skeleton of a new one for someone else to work on and a test suite for it.
  • Make sure your implementation passes the previous tests before opening a Pull Request.
  • Do not use any npm functions or javascript built-in methods.

Project Structure

All methods will live in the src directory. They should be written as [methodName].js.

All tests will live in the test directory. A test file should be formatted [methodName].test.js to reflect what method is being tested.

A skeleton of new method

export default () => {
  // TO IMPLEMENT IN ANOTHER PR
};

Test suite example

import abs from '../src/abs';

describe('abs', () => {
  test('absolute of 0 to equal 0', () => {
    expect(abs(0)).toBe(0);
  });

  test('absolute of 1 to equal 1', () => {
    expect(abs(1)).toBe(1);
  });

  test('absolute of -1 to equal 1', () => {
    expect(abs(-1)).toBe(1);
  });
});

About

Enjoy! #hacktoberfest

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%