Skip to content

luisfuentech/Javascript-Utilities

Repository files navigation

Javascript & NodeJS utilities

Place to put you useful and tricky JS algorithms to help optimize stuff and help other developers

Contributing

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

Module's Structure

module
 |--index.js
 |--example.js
 |--README.md
 |--LICENSE

Every single module must follow at least the next structure:

  • index: Contains the main or hole code or algorithms you want to contribuite
  • example: This file show us how use the utily with a practical example
  • README: Describe what do the utily, types of returns, parameters, etc and how to use it
  • LICENCE: It's the MIT License

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft

About

This is the very beginning of tricky and useful algorithms

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •