tronbox/CONTRIBUTING.md

TronBox - Simple development framework for Tron

## Contributing

We appreciate your interest in contributing! Please follow these steps to get started:

1. **Fork this repository.**

2. **Clone your forked repository.**

   Use the following command to clone it:

   ```bash
   git clone git@github.com:your-username/tronbox.git
   ```

   Replace `your-username` with your GitHub username.

3. **Install Node.js using nvm.**

   Make sure to use a version higher than 18. You can install the recommended version like this:

   ```bash
   nvm install v18.20.8
   nvm use v18.20.8
   ```

4. **Install the project's dependencies.**

   Run the following command in the root of the project:

   ```bash
   npm install
   ```

5. **Run the unbuilt version of TronBox for better debugging during development.**

   You can do this with the following command:

   ```bash
   ./tronbox.dev migrate --reset
   ```

If you like this project, please consider giving it a star!

Thank you for your contributions!