Gibbons NPM | npm.io

Gibbons

"Leaping from branch to branch gibbons decide which one to take in a split second"

Gibbons is a Node.js module which helps in managing user groups and user permissions with bitwise efficiency. In applying ArrayBuffers and bitwise operations it tries to use minimal resources.

API Documentation and tutorial

See: Gibbons Docs

How do I get set up?

npm install gibbons

Details

Prerequisites to contribute

Clone this repository, and check out the develop branch
Ensure Node Version Manager is installed and operational
nvm install

Linting

For this project ESLint is applied.

Execute: npm run lint

Currently the linter conforms to defaults from: eslint-plugin-node and some minor tweaks (see: .eslintrc).

Unit tests

Every path should be covered and can be checked after the unit test is executed, according to a coverage report.

Execute: npm test

In the end, a brief version of the coverage report is shown. For the more extensive one, see: docs/coverage/lcov-report/index.html.

API Documentation

jsdoc is applied to generate the API documentation.

It's expected to write extensive comments in the code itself when contributing.

Every time code is updated, we need to ensure the documentation is in sync with the code.

Execute: npm run docs

The result is generated at: docs/index.html

Contribution guidelines

When adding new features / code, creating corresponding unit tests are mandatory
Code review will be done by means of pull requests to the develop branch, preferably with the following pull request template:

h1. I ensured:
* [ ] I've updated the unit tests and covered enough parts of the code (`npm run lint` and `npm test`)
* [ ] I've updated the API documentation within the code and generated a fresh export (`npm run docs`)