Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 3.08 KB

subsystem_types.md

File metadata and controls

47 lines (29 loc) · 3.08 KB

GoCryptoTrader package Subsystem types

Build Status Software License GoDoc Coverage Status Go Report Card

This subsystem_types package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progress on our GoCryptoTrader Kanban board.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Current Features for Subsystem types

  • Subsystem contains subsystems that are used at run time by an engine.Engine, however they can be setup and run individually.
  • Subsystems are designed to be self contained
  • All subsystems have a public Setup(...) (..., error) function to return a valid subsystem ready for use
    • Subsystems which are designed to be switched off also have Start(...) error, IsRunning() bool and Stop(...) error functions to allow the main engine.Engine instance to manage them
  • Common subsystem types such as errors can be found within the subsystem.go file

Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Code must adhere to our coding style.
  • Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc