First and most important: thanks a lot for choosing this project as a place to which you are planning to invest your time and knowledge!
This guide contains as much information as possible that should help you to join to the development.
Please feel free to enrich this document through PR requests.
I am highly recommend to discuss a new feature through issues section before development to be sure that feature is not yet already done or someone already doing it.
The project trying to follow simple 'git flow':
masterbranch should be always available for 'testing' use (i.e. available for build, run and not to fail)- tagged commit means stable version
- (recommended, but not critical) new features should come from
feature/some-namebranches, bug-fixes frombug/bug-nameand so on. Don't stuck on it too much: if you can't really decide which branch name required - usefeature/prefix
Simple way to understand project is to look at plugins implementation. They are relatively simple and standardized
Useful resources:
- Good tutorial how to create PR from GitHub.
- Go: at this time project aims to the latest golang toolchain (1.12 now), however if you will use newer version please note it in the PR.
- Modules: the project is using go1.11+ modules without
vendordirectory. - IDE: Me (reddec) personally using Jetbrains Goland as a professional user, however you may use free combination of IDEA community edition + Golang plugin. Or whatever you want - just please don't commit IDE files to the repository
- Install go and setup GOPATH
- Clone project through git
- In the project directory download all dependency for the command:
GO111MODULE=on go get -v ./... - Build it:
GO111MODULE=on go build ./cmd/... - Run it:
./monexec --help
docs- site and project documentationmonexec- root configurationplugins- plugin implementationpool- core (need refactor) supervisor logicsample- examples and configuration filesui- sub-module for UIswagger.yaml- swagger definition of HTTP plugin endpoints