Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

98 lines (64 loc) · 2.79 KB
Raw

Contributing to bv-ui-core

Owners

  • Reason (@reason-bv)
  • Dan Heberden (@danheberden)

Getting Started

Start by creating a fork of this repo, cloning it locally, and installing the required Node modules:

git clone [email protected]:<yourusername>/bv-ui-core.git
cd bv-ui-core
npm install

Verify the installation by running npm run dev. This should open Chrome to the test page; you will need to open the browser's console to see the test results.

If you would like to submit a change to the repo, open a pull request from a branch on your fork. Do not create new branches on the main repo.

Adding New Modules

If you want to submit a new module, be certain to open an issue explaining the rationale for adding the module, as well as the proposed API for the module. Please do not start the discussion with a pull request.

Given that the modules in this repo are intended for use in user interfaces, please be extremely mindful of adding dependencies. Wherever possible, a module should allow dependencies to be passed to it as arguments:

module.exports = function myModule ($) {
    return {
        awesome: function (arg) {
            return $(arg);
        }
    };
};

File Structure

For a module foo, at least the following files should exist:

  • lib/foo/index.js
  • lib/foo/README.md
  • test/unit/foo/index.js

Commit Hooks

This project uses ghooks to manage Git hooks. The hooks run linting before each commit, and run the tests before each push.

Style

The coding style for this project is checked with ESLint, and defined by the .eslintrc file. To run ESLint:

npm run lint

If you see no output, no problems were found.

Tests

This project uses tape. To run the tests:

npm test

To run the tests in a browser while you are doing development:

npm run dev

Note that the results appear in the console, not in the browser itself.

Local Development with Another Project

If you are working on this project alongside a project that uses it, you will likely want to use npm link. It allows you to install an NPM package in your project from the local file system, rather than pulling the package down from NPM.

Assuming that you've checked out bv-ui-core to ~/code/bv-ui-core and your project is at ~/code/my-project, you can run the following commands in the shell to get your project to use the local bv-ui-core:

cd ~/code/bv-ui-core
npm link
cd ~/code/my-project
npm link bv-ui-core

Alternatively, you can combine the two steps into one:

cd ~/code/my-project
npm link ../bv-ui-core

See the npm link documentation for more details.