How do I work on this project?

[Asday]

I forked and checked out this repository with the intent of fixing an issue I have with it, but fell down before even getting it running.

The readme says

Clone this repository to $GOPATH/src/github.com/mailhog/MailHog and type make deps.

But there's nothing in the makefile about deps, so I get make: *** No rule to make target 'deps'. Stop.. It then directs me to MailHog/BUILD.md which says

MailHog is built using make, and using this Makefile.

But make just returns:

go fmt ./...
go: cannot find main module, but found vendor/vendor.json in /home/asday/code/src/github.com/asday/MailHog
	to create a module there, run:
	go mod init
make: *** [Makefile:12: fmt] Error 1

I see that after formatting, the makefile tries to run go install ., so I tried that, and get

go: cannot find main module, but found vendor/vendor.json in /home/asday/code/src/github.com/asday/MailHog
	to create a module there, run:
	go mod init

Back in the readme, it says

Run tests using make test or goconvey.

But there's no test rule in the makefile, and I don't have goconvey installed, whatever that might be.

$ go version
go version go1.16.3 linux/amd64
$ go env
GO111MODULE=""
GOARCH="amd64"
GOBIN=""
GOCACHE="/home/asday/.cache/go-build"
GOENV="/home/asday/.config/go/env"
GOEXE=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="linux"
GOINSECURE=""
GOMODCACHE="/home/asday/code/pkg/mod"
GONOPROXY=""
GONOSUMDB=""
GOOS="linux"
GOPATH="/home/asday/code/"
GOPRIVATE=""
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/usr/lib/go"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/usr/lib/go/pkg/tool/linux_amd64"
GOVCS=""
GOVERSION="go1.16.3"
GCCGO="gccgo"
AR="ar"
CC="gcc"
CXX="g++"
CGO_ENABLED="1"
GOMOD="/dev/null"
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -fmessage-length=0 -fdebug-prefix-map=/tmp/go-build2710365042=/tmp/go-build -gno-record-gcc-switches"

[ynori7]

This repo is extremely outdated. You need to explicitly set GO111MODULE=off to build and run it.

[gedge]

or use PR #349 as a base - which has converted the project to modules

[gedge]

actually, I've merged this branch into https://github.com/mailhog/MailHog/tree/release/1.1.0-beta1
for further testing

[ynori7]

In case it's also useful for anyone, I've also got a fork which I turned into a monorepo which fixes a number of major performance issues and brings the project up-to-date: https://github.com/ynori7/mailhog

[gedge]

@ynori7 - thanks, is it possible we can get that work upstreamed?

[ynori7]

@gedge I guess it would be a little tough since I severed the link to the original repo since it was no longer really a fork of mailhog/Mailhog but rather a new repo containing all of the mailhog repos with cleaner package names. We could probably merge them, but there would be breaking changes.