---
layout: default
---

# Contributing to sonetel-node

Thanks for checking out this sonetel-node. I am excited to hear and learn from you. Your experiences will benefit others who use this library.

I've put together the following guidelines to help you figure out where you can best be helpful.

## Table of Contents

1. [What we're looking for](#what-were-looking-for)
2. [Ground rules & expectations](#ground-rules--expectations)
3. [How to contribute](#how-to-contribute)
4. [Setting up your environment](#setting-up-your-environment)
5. [Community](#community)

## What we're looking for

There are many ways you can directly contribute to this project, such as:

* Add new features (see enhancements)
* Fix open issues (see bugs)
* Improve documentation

## Ground rules & expectations

Before we get started, here are a few things we expect from you (and that you should expect from others):

* Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on how something is done. Try to listen to others rather than convince them that your way is correct.
* This project is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
* Please ensure that your contribution passes all tests if you open a pull request. If there are test failures, you will need to address them before we can merge your contribution.
* When adding content, please consider if it is widely valuable. Please don't add references or links to things you or your employer have created, as others will do so if they appreciate it.

## How to contribute

If you'd like to contribute, start by searching through the [pull requests](https://github.com/github/opensource.guide/pulls) to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this guide, open a pull request.

## Setting up your environment

- Clone the repository `cd` into the `sonetel-node` folder.
- If using NVM, install and switch to the Node version mentioned in [.nvmrc](.nvmrc) with the `nvm use` command.
- Run `node install` to install all the project dependencies.

## Community

Discussions about sonetel-node take place on this repository's [Issues](https://github.com/aashish-joshi/sonetel-node/issues) and [Pull Requests](https://github.com/aashish-joshi/sonetel-node/pulls) sections. Anybody is welcome to join these conversations.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.