Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

50 lines (32 loc) · 1.87 KB
Raw

Contributing Guidelines

Thank you for considering contributing to our project! Before you proceed, please take a moment to review the following guidelines.

Table of Contents

Introduction

This project is a client for receiving blockchain data through block explorers, particularly tronscan. It currently provides methods to interact with the blockchain, as demonstrated in the examples in the README.

Setting Up the Project

To set up the project locally, follow these steps:

  1. Clone the repository from GitHub.
  2. Install the necessary dependencies using npm install.
  3. Ensure you have an API key from the block explorer service you intend to use.

Making Changes

When making changes to the project, please keep the following in mind:

  • Follow the coding style and conventions used in the existing codebase.
  • Write clear and concise commit messages.
  • Test your changes thoroughly before submitting a pull request.

Submitting Changes

To submit your changes, please follow these steps:

  1. Fork the repository on GitHub.
  2. Create a new branch for your changes (git checkout -b feature/your-feature-name).
  3. Make your changes and commit them with descriptive messages.
  4. Push your changes to your fork (git push origin feature/your-feature-name).
  5. Open a pull request on the main repository.

Additional Resources

If you have any questions or need further assistance, feel free to reach out to us via the issue tracker or by contacting the project maintainers.

We appreciate your contributions to our project!