Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (36 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 1.47 KB

Contribution Guide

Contributions are welcome and appreciated!

Setting up your environment

First fork the repo to your own github org, then do the following steps to get started:

# clone your fork to your local machine
git clone https://github.com/YOUR_USER_OR_ORG/raygun-sourcemap-webpack-plugin.git

# change to local repo directory
cd raygun-sourcemap-webpack-plugin

# install dependencies
npm install

Running Tests

npm test

Style & Linting

The codebase adheres to the Airbnb Styleguide with some tweaks per our personal preferences and is enforced using ESLint.

npm run lint

Building the plugin

Source code for the plugin is written with ES6 syntax and transpiled using babel. The build is output to ./dist.

npm run build

Test coverage

We use the excellent module, nyc, for coverage and strive for 100%. The coverage report will be displayed in the terminal after tests run.

Pull Request Guidelines

Before you submit a pull request from your forked repo, check that it meets these guidelines:

  1. If the pull request fixes a bug, it should include tests that fail without the changes, and pass with them.
  2. Please update README.md accordingly, if relevant, as part of the same PR.
  3. Please rebase and resolve all conflicts before submitting.