docs: Add CODING_GUIDELINES.md and other adjustments (#1988)

* docs: Create new CODING_GUIDELINES doc Rids excess contribution instructions from other packages Adds AGENTS.md file for the AI overlords Rids unused templates Updates ADD_NEW_EXCHANGE.md with minor fixes * docs: Fix linter issues and minor adjustments based on Copilot feedback * docs: Update coding guidelines for API parameters and testing practices * docs: Remove redundant GoDoc references Adds copilot-instructions.md * docs: Update CODING_GUIDELINES with export recommendations and test commentary * docs: Fix formatting inconsistencies in ADD_NEW_EXCHANGE.md links * docs: Update struct naming conventions for request and response types * docs: Improve clarity and consistency in ADD_NEW_EXCHANGE.md and CODING_GUIDELINES.md * refactor: Simplify error handling in QueryOrder method
2026-06-03 15:10:49 +00:00 · 2025-08-08 12:10:53 +10:00
parent 90187a3a5a
commit ba92ba3254
261 changed files with 928 additions and 2859 deletions
--- a/cmd/documentation/engine_templates/apiserver.tmpl
+++ b/cmd/documentation/engine_templates/apiserver.tmpl
@@ -22,7 +22,5 @@
 | maxAuthFailures | For authenticated endpoints, the amount of failed attempts allowed before disconnection | `3` |
 | allowInsecureOrigin | Allows use of insecure connections | `true` |

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/communication_manager.tmpl
+++ b/cmd/documentation/engine_templates/communication_manager.tmpl
@@ -48,9 +48,5 @@
 | verbose | If enabled will log more details to your logger output | `false` |
 | verificationToken | The token generated by Telegram to allow you to send messages | `iamafaketoken` |

-
-
-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/connection_manager.tmpl
+++ b/cmd/documentation/engine_templates/connection_manager.tmpl
@@ -12,8 +12,5 @@
 | preferredDomainList |  Is a string array of domains to periodically verify whether GoCryptoTrader is connected to the internet |  `["www.google.com","www.cloudflare.com","www.facebook.com"]` |
 | checkInterval | A time period in golang `time.Duration` format to check whether GoCryptoTrader is connected to the internet | `1000000000` |

-
-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/currency_state_manager.tmpl
+++ b/cmd/documentation/engine_templates/currency_state_manager.tmpl
@@ -9,6 +9,5 @@
 + This allows for an internal state check to compliment internal and external 
 strategies.

-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/database_connection.tmpl
+++ b/cmd/documentation/engine_templates/database_connection.tmpl
@@ -24,7 +24,5 @@
 | database | The name of the database | `database.db` |
 | sslmode | The connection type of the database for Postgres databases only | `disable` |

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/datahistory_manager.tmpl
+++ b/cmd/documentation/engine_templates/datahistory_manager.tmpl
@@ -187,9 +187,5 @@ The candle table also has relationships to data history jobs. Only the relevant
 | validation_job_id | When job id for what job validated the candle data | `deadbeef-dead-beef-dead-beef13371337` |
 | validation_issues | If any discrepancies are found, the data will be written to the column | `issues found at 2020-07-08 00:00:00, Open api: 9262.62 db: 9262.69 diff: 3%, replacing database candle data with API data` |

-
-
-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/depositaddress.tmpl
+++ b/cmd/documentation/engine_templates/depositaddress.tmpl
@@ -4,8 +4,5 @@
 + The deposit address manager subsystem stores Exchange deposit addresses.
 + On start of the application the engine Bot will retrieve deposit addresses from exchanges if you have API keys set

-
-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/event_manager.tmpl
+++ b/cmd/documentation/engine_templates/event_manager.tmpl
@@ -11,8 +11,5 @@
 | eventmanagerdelay | Sets the event managers sleep delay between event checking by a Golang `time.Duration` |  `0` |
 | verbose | Outputs debug messaging allowing for greater transparency for what the event manager is doing |  `false` |

-
-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/exchange_manager.tmpl
+++ b/cmd/documentation/engine_templates/exchange_manager.tmpl
@@ -5,7 +5,5 @@
 + The exchange manager itself is not customisable, it is always enabled.
 + The exchange manager by default will load all exchanges that are enabled in your config, however, it will also load exchanges by request via GRPC commands

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/ntp_manager.tmpl
+++ b/cmd/documentation/engine_templates/ntp_manager.tmpl
@@ -15,8 +15,5 @@
 | allowedDifference | A Golang time.Duration representation of the allowable time discrepancy between NTP server and your system time. Any discrepancy greater than this allowance will display an alert to your logging output |  `50000000` |
 | allowedNegativeDifference | A Golang time.Duration representation of the allowable negative time discrepancy between NTP server and your system time. Any discrepancy greater than this allowance will display an alert to your logging output |  `50000000` |

-
-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/order_manager.tmpl
+++ b/cmd/documentation/engine_templates/order_manager.tmpl
@@ -6,7 +6,5 @@
 + All orders placed via GoCryptoTrader will be added to the order manager store
 + Any futures based order will be tracked via the [futures positions controller](/exchanges/order/README.md) which can be used to track PNL. Use GRPC command [getfuturesposition](https://api.gocryptotrader.app/#gocryptotrader_getfuturesposition) to view position data for an exchange, asset, pair

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/portfolio_manager.tmpl
+++ b/cmd/documentation/engine_templates/portfolio_manager.tmpl
@@ -25,8 +25,5 @@
 | ColdStorage | Describes whether the wallet address is a cold storage wallet eg Ledger | `false`  |
 | SupportedExchanges | A comma delimited string of which exchanges are allowed to interact with this wallet | `"Binance"`  |

-
-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/subsystem_types.tmpl
+++ b/cmd/documentation/engine_templates/subsystem_types.tmpl
@@ -7,7 +7,5 @@
  + 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
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/sync_manager.tmpl
+++ b/cmd/documentation/engine_templates/sync_manager.tmpl
@@ -15,8 +15,5 @@
 | synccontinuously | Whether to sync exchange data continuously (ticker, orderbook and trades) | `true` |
 | synctimeout | The amount of time in golang `time.Duration` format before the syncer will switch from one protocol to the other (e.g. from REST to websocket) | `15000000000` |

-
-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/websocketroutine_manager.tmpl
+++ b/cmd/documentation/engine_templates/websocketroutine_manager.tmpl
@@ -7,8 +7,5 @@
 + The websocket routine manager subsystem can be enabled or disabled via runtime command `-websocketroutine=false` defaulting to true
 + Logs can be customised to display values the config value `fiatDisplayCurrency` under `currencyConfig`

-
-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/engine_templates/withdraw_manager.tmpl
+++ b/cmd/documentation/engine_templates/withdraw_manager.tmpl
@@ -8,8 +8,5 @@
 + Will not process withdrawal events if `dryrun` is true
 + The withdraw manager subsystem is always enabled

-
-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}