Contributing to Shortscan

Contributions to shortscan are welcome. Whether it's reporting a bug, suggesting a feature, or submitting code, your input is valuable.

Development Setup

To get started with developing shortscan, you'll need to set up a local Go environment.

1. Clone the repository:

   git clone https://github.com/bitquark/shortscan.git
   cd shortscan

2. Install dependencies:

   The go get command will download the necessary dependencies as defined in go.mod.

   go get

3. Build the binaries:

   You can build shortscan and shortutil to test your changes locally.

   go build ./cmd/shortscan
   go build ./cmd/shortutil

   This will create the executable files in the root directory of the project.

Reporting Issues

If you encounter a bug or have a suggestion for a new feature, please open an issue on the GitHub repository. Provide as much detail as possible, including:

• The command you ran.
• The full output, especially when using a higher verbosity level (-v 1 or -v 2).
• The expected behavior.
• The actual behavior.

Submitting Changes

Pull requests are the preferred way to contribute code. Please ensure your code is well-commented and follows the existing style.

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes.
4. Submit a pull request with a clear description of your changes.