https://github.com/blakeguilloud/ganon
A javascript library
https://github.com/blakeguilloud/ganon
hacktoberfest javascript
Last synced: about 1 year ago
JSON representation
A javascript library
- Host: GitHub
- URL: https://github.com/blakeguilloud/ganon
- Owner: BlakeGuilloud
- License: mit
- Created: 2017-03-04T14:24:34.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T20:39:52.000Z (over 3 years ago)
- Last Synced: 2024-04-14T21:47:23.301Z (about 2 years ago)
- Topics: hacktoberfest, javascript
- Language: JavaScript
- Homepage:
- Size: 963 KB
- Stars: 93
- Watchers: 3
- Forks: 196
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Ganon is a javascript library designed and maintained by open source contributors.
### A HUGE THANKS!!
A very special thanks to [@csleong98](https://github.com/csleong98) for designing our logo!
Huge props to [@andreasgruenh](https://github.com/andreasgruenh) and [@ktilcu](https://github.com/ktilcu) for helping collaborate.
And the biggest of credit goes to all of our awesome [Contributors](https://github.com/BlakeGuilloud/ganon/graphs/contributors)!!
### Usage
```bash
$ yarn add ganon
```
NodeJS
```javascript
// import { sum } from 'ganon';
const { sum } = require('ganon');
const sumOfOneAndTwo = sum(1, 2);
=> 3
```
Javascript
```javascript
// import sum from 'ganon/dist/sum';
const sum = require('ganon/dist/sum');
const sumOfOneAndTwo = sum(1, 2);
=> 3
```
### Objective
To build a suite of javascript methods by the time [hacktoberfest](https://hacktoberfest.digitalocean.com/) ends! Let's get some T-shirts!!
Ganon is designed to get as many people involved as possible, so our objective here is to fix or improve an existing method and then write the skeleton of a desired method for someone else to build. In the spirit of getting everyone involved, please only fix one or two methods at a time and make sure to push up something for someone else to work on!
This project was created to have fun.
### Project Structure
All methods will live in the `lib` directory of the project. They should be written as [methodName].js, required and exported in `lib/index.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.
### Contributing
Please read our [Contributing Guide](https://github.com/BlakeGuilloud/ganon/blob/master/CONTRIBUTING.md) for information on how to contribute to this project! All skill levels are more than welcome to participate in this project!
### Demo
We're going to walk through the process of taking on an issue, resolving it, writing a new issue, and shipping some code.
The method we are going to resolve is called `sum`:
```javascript
// lib/sum.js
function sum(a, b) {
// Your code goes here.
}
module.exports = sum;
```
In order to test this method, we will first run `yarn test sum`:
```bash
$ yarn test sum
FAIL problems/sum.test.js
✕ adds 1 + 2 to equal 3 (8ms)
✕ adds 3 + 4 to equal 7 (1ms)
● adds 1 + 2 to equal 3
expect(received).toBe(expected)
Expected value to be (using ===):
3
Received:
undefined
```
As you can see, there is something wrong with the function sum, so let's resolve it:
```javascript
// lib/sum.js
function sum(a, b) {
return a + b;
}
module.exports = sum;
```
Run the test again:
```bash
$ yarn test sum
PASS problems/sum.test.js
✓ adds 1 + 2 to equal 3 (6ms)
✓ adds 3 + 4 to equal 7 (1ms)
```
Now that I have fixed the sum function to return the desired value, I need to write the skeleton of a new method for other contributors to work on. Let's write one called `difference`:
```javascript
// lib/difference.js
// Write a function that returns the difference of the first two parameters
function difference(a, b) {
// Your code goes here.
}
module.exports = difference;
```
We will need to accompany this method with a test(s) to ensure it returns the proper value:
```javascript
// test/difference.test.js
const { difference } = require("../lib");
describe("difference", () => {
test("subtracts 1 - 3 to equal -2", () => {
expect(difference(1, 3)).toBe(-2);
});
test("subtracts 10 - 3 to equal 7", () => {
expect(difference(10, 3)).toBe(7);
});
});
```
Now that we have fixed a method, written the skeleton of a new method, and a test to accompany it, we can push up our changes and open a pull request. :fire: :fire: :fire: