Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (35 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

61 lines (35 loc) · 1.38 KB

Contributing Guide

Thanks for your interest in contributing to this project! This document aims to serve as a friendly guide for making your first contribution.

Developing

You will need:

Cloning the project

git clone https://github.com/izavits/node.analytics.git
cd node.analytics

Installing npm dependencies

Install the npm dependencies by running:

npm install

Testing

To run the test suite, run the following command:

npm test

The test suite is run automatically by CI servers when you send a pull request.

Sending a pull request

When sending a pull request, consider the following guidelines:

  • Write a concise commit message explaining your changes.

  • If applies, write more descriptive information in the commit body.

  • Refer to the issue/s your pull request fixes (if there are issues in the github repo).

  • Write a descriptive pull request title.

  • Squash commits when possible.

Before your pull request can be merged, the following conditions must hold:

  • All the tests passes.

  • The coding style aligns with the project's convention.

  • Your changes are confirmed to be working.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub