@regang/keen-core/CONTRIBUTING.md

Core functionality powering Keen IO's modular JavaScript SDKs

# We <3 Contributions!

This is an open source project and we love involvement from the community! Hit us up with pull requests and issues. The more contributions the better!

Run the following commands to install and build this project:

```ssh

# Clone the repo

$ git clone https://github.com/keen/keen-core.js.git && cd keen-core.js


# Install project dependencies

$ npm install

# npm install -g gulp


# Build and launch to view test results

$ gulp

$ open http://localhost:9003
```


## Submitting a Pull Request

Use the template below. If certain testing steps are not relevant, specify that in the PR. If additional checks are needed, add 'em! Please run through all testing steps before asking for a review.


```markdown


## What does this PR do? How does it affect users?


## How should this be tested?

Step through the code line by line. Things to keep in mind as you review:
 - Are there any edge cases not covered by this code?
 - Does this code follow conventions (naming, formatting, modularization, etc) where applicable?

Fetch the branch and/or deploy to staging to test the following:

- [ ] Does the code compile without warnings (check shell, console)?
- [ ] Do all tests pass? (run `gulp with-tests`)
- [ ] Does the UI, pixel by pixel, look exactly as expected (check various screen sizes, including mobile)?
- [ ] If the feature makes requests from the browser, inspect them in the Web Inspector. Do they look as expected (parameters, headers, etc)?
- [ ] If the feature sends data to Keen, is the data visible in the project if you run an extraction (include link to collection/query)?
- [ ] If the feature saves data to a database, can you confirm the data is indeed created in the database?


## Related tickets?

```