Contributing to LiveGo

We welcome contributions to the LiveGo project! Whether it's reporting a bug, suggesting a feature, or submitting code, your help is appreciated.

Development Setup

To get started with developing on LiveGo, you'll need a Go development environment.

1. Clone the repository:

   git clone https://github.com/gwuhaolin/livego.git
   cd livego

2. Install Dependencies: The project uses Go modules to manage dependencies. They will be downloaded automatically when you build or test the project. You can also download them manually:

   go mod tidy
   go mod download

Running Tests

LiveGo uses the standard Go testing framework. The Makefile provides a convenient command to run all tests.

make test

This is equivalent to running:

go test -v ./...

Our continuous integration pipeline, defined in .github/workflows/test.yml, runs these tests automatically for every push and pull request on Windows, macOS, and Ubuntu to ensure cross-platform compatibility.

Building the Project

To build the livego binary, use the make build command:

make build

This will produce an executable file named livego in the project root.

Submitting Changes

1. Fork the repository on GitHub.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with clear, descriptive messages.
4. Ensure all tests pass by running make test.
5. Push your branch to your fork.
6. Open a pull request against the master branch of the gwuhaolin/livego repository.

We will review your pull request as soon as possible. Thank you for your contribution!