tanglepay-sdk-monorepo/CONTRIBUTING.md

DApp SDK to interact with TanglePay wallets

# Contributing to TanglePay SDK

We appreciate your interest in contributing to the TanglePay SDK! This document provides guidelines to help ensure a smooth and efficient contribution process.

## Code of Conduct

By participating in this project, you agree to adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md). Please take a moment to read it.

## Getting Started

1. Fork the repository on GitHub.
2. Clone your fork of the repo: `git clone https://github.com/TanglePay/TanglePay-SDK.git`
3. Navigate to the project directory: `cd tanglepay-sdk`
4. Install dependencies: `npm install`
5. Create a new branch for your changes: `git checkout -b your-feature-branch`

## Developing

When making changes, please follow these guidelines:

1. Follow the existing coding style and conventions.
2. Write clear and concise commit messages.
3. Keep your changes focused on a single feature or bugfix.
4. Add tests for any new functionality or bug fixes.
5. Update the documentation when necessary.

## Submitting a Pull Request

1. Ensure all tests pass and there are no linting errors: `npm test`
2. Commit your changes: `git commit -m "Your descriptive commit message"`
3. Push your branch to your fork: `git push origin your-feature-branch`
4. Create a pull request from your fork to the original repository.

Please provide a clear and concise description of your changes in the pull request. If your changes relate to an existing issue, please reference the issue number in the pull request.

## Review Process

After submitting a pull request, a maintainer will review your changes. They may request changes or provide feedback to help improve your submission. Once your changes are approved, they will be merged into the main repository.

## License

By contributing to TanglePay SDK, you agree that your contributions will be licensed under the same [MIT License](./LICENSE) used by the project.

Thank you for your interest in contributing to the TanglePay SDK!