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-02 15:10:46 +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/exchanges_templates/alert.tmpl
+++ b/cmd/documentation/exchanges_templates/alert.tmpl
@@ -86,7 +86,5 @@ func ABadExampleRoutineThatWaits(potentialChange *SomeChangingType) {
 }
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/binance.tmpl
+++ b/cmd/documentation/exchanges_templates/binance.tmpl
@@ -100,7 +100,5 @@ if err != nil {
 	// supplied then
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/binanceus.tmpl
+++ b/cmd/documentation/exchanges_templates/binanceus.tmpl
@@ -100,7 +100,5 @@ if err != nil {
 	// supplied then
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/bitfinex.tmpl
+++ b/cmd/documentation/exchanges_templates/bitfinex.tmpl
@@ -100,7 +100,5 @@ if err != nil {
 	// supplied then
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/bitflyer.tmpl
+++ b/cmd/documentation/exchanges_templates/bitflyer.tmpl
@@ -99,7 +99,5 @@ if err != nil {
 	// supplied then
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/bithumb.tmpl
+++ b/cmd/documentation/exchanges_templates/bithumb.tmpl
@@ -92,7 +92,5 @@ if err != nil {
 }
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/bitmex.tmpl
+++ b/cmd/documentation/exchanges_templates/bitmex.tmpl
@@ -92,7 +92,5 @@ if err != nil {
 }
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/bitstamp.tmpl
+++ b/cmd/documentation/exchanges_templates/bitstamp.tmpl
@@ -100,7 +100,5 @@ if err != nil {
 	// supplied then
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/btcmarkets.tmpl
+++ b/cmd/documentation/exchanges_templates/btcmarkets.tmpl
@@ -93,7 +93,5 @@ if err != nil {
 }
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/btse.tmpl
+++ b/cmd/documentation/exchanges_templates/btse.tmpl
@@ -93,7 +93,5 @@ if err != nil {
 }
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/bybit.tmpl
+++ b/cmd/documentation/exchanges_templates/bybit.tmpl
@@ -100,7 +100,5 @@ if err != nil {
 	// supplied then
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/coinbasepro.tmpl
+++ b/cmd/documentation/exchanges_templates/coinbasepro.tmpl
@@ -100,7 +100,5 @@ if err != nil {
 	// supplied then
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/coinut.tmpl
+++ b/cmd/documentation/exchanges_templates/coinut.tmpl
@@ -100,7 +100,5 @@ if err != nil {
 	// supplied then
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/deribit.tmpl
+++ b/cmd/documentation/exchanges_templates/deribit.tmpl
@@ -111,7 +111,5 @@ kline.Raw Interval configurable for a raw orderbook subscription when authentica

 Subscriptions are subject to enabled assets and pairs.

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/exchanges_mock_readme.tmpl
+++ b/cmd/documentation/exchanges_templates/exchanges_mock_readme.tmpl
@@ -171,7 +171,5 @@ func TestDummyTest(t *testing.T) {
 	}
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/exchanges_orderbook_readme.tmpl
+++ b/cmd/documentation/exchanges_templates/exchanges_orderbook_readme.tmpl
@@ -35,7 +35,5 @@ if err != nil {
 }
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/exchanges_readme.tmpl
+++ b/cmd/documentation/exchanges_templates/exchanges_readme.tmpl
@@ -16,7 +16,5 @@ implementation
 + If contributing websocket improvements, please make sure order reports 
 follow [these rules](../docs/WS_ORDER_EVENTS.md).

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/exchanges_stats_readme.tmpl
+++ b/cmd/documentation/exchanges_templates/exchanges_stats_readme.tmpl
@@ -8,7 +8,5 @@ enabled exchanges i.e.
 	- Sort by best price for currency
 	- Others will be added soon

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/exchanges_ticker_readme.tmpl
+++ b/cmd/documentation/exchanges_templates/exchanges_ticker_readme.tmpl
@@ -36,7 +36,5 @@ if err != nil {
 }
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/exchanges_trade_readme.tmpl
+++ b/cmd/documentation/exchanges_templates/exchanges_trade_readme.tmpl
@@ -66,8 +66,5 @@ _b in this context is an `IBotExchange` implemented struct_
 | Poloniex | Yes | Yes | Yes |
 | Yobit | Yes | NA | No |

-
-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/exmo.tmpl
+++ b/cmd/documentation/exchanges_templates/exmo.tmpl
@@ -92,7 +92,5 @@ if err != nil {
 }
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/gateio.tmpl
+++ b/cmd/documentation/exchanges_templates/gateio.tmpl
@@ -99,7 +99,5 @@ if err != nil {
 	// supplied then
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/gemini.tmpl
+++ b/cmd/documentation/exchanges_templates/gemini.tmpl
@@ -92,7 +92,5 @@ if err != nil {
 }
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/hitbtc.tmpl
+++ b/cmd/documentation/exchanges_templates/hitbtc.tmpl
@@ -112,7 +112,5 @@ Subscriptions are subject to enabled assets and pairs.

 Configure Levels for number of history entries to return for applicable APIs.

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/huobi.tmpl
+++ b/cmd/documentation/exchanges_templates/huobi.tmpl
@@ -111,7 +111,5 @@ Default Authenticated Subscriptions:
 - Account Orders
 - Account Updates

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/kraken.tmpl
+++ b/cmd/documentation/exchanges_templates/kraken.tmpl
@@ -92,7 +92,5 @@ if err != nil {
 }
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/kucoin.tmpl
+++ b/cmd/documentation/exchanges_templates/kucoin.tmpl
@@ -36,8 +36,5 @@ Unimplemented subscriptions:
 - Candles for Futures
 - Market snapshot for currency

-### Please click GoDocs chevron above to view current GoDoc information for this package
-
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/lbank.tmpl
+++ b/cmd/documentation/exchanges_templates/lbank.tmpl
@@ -92,7 +92,5 @@ if err != nil {
 }
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/nonce.tmpl
+++ b/cmd/documentation/exchanges_templates/nonce.tmpl
@@ -4,7 +4,5 @@

 + This package services the exchanges package with nonce creation.

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/okx.tmpl
+++ b/cmd/documentation/exchanges_templates/okx.tmpl
@@ -114,7 +114,5 @@ if err != nil {
 	// supplied then
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/orders.tmpl
+++ b/cmd/documentation/exchanges_templates/orders.tmpl
@@ -9,7 +9,5 @@

 + For futures orders, this package also contains a futures position controller. It is responsible for tracking all futures orders that GoCryptoTrader processes. It keeps a running history of realised and unreaslied PNL to allow a trader to track their profits. Positions are closed once the exposure reaches zero, then upon a new futures order being processed, a new position is created. To view futures positions, see the GRPC command `getfuturesposition`

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/poloniex.tmpl
+++ b/cmd/documentation/exchanges_templates/poloniex.tmpl
@@ -100,7 +100,5 @@ if err != nil {
 	// supplied then
 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/request.tmpl
+++ b/cmd/documentation/exchanges_templates/request.tmpl
@@ -5,7 +5,5 @@
 + This package services the exchanges package with request handling.
 	- Throttling of requests for an individual exchange

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
-{{end}}
+{{end}}
--- a/cmd/documentation/exchanges_templates/subscription.tmpl
+++ b/cmd/documentation/exchanges_templates/subscription.tmpl
@@ -53,6 +53,5 @@ Templates do not need to worry about joining around separators; Trailing separat

 Template functions should panic to handle errors. They are caught by text/template and turned into errors for use in `subscription.expandTemplate`.

-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/validate.tmpl
+++ b/cmd/documentation/exchanges_templates/validate.tmpl
@@ -72,7 +72,5 @@ if err != nil {

 ```

-### Please click GoDocs chevron above to view current GoDoc information for this package
-{{template "contributions"}}
 {{template "donations" .}}
 {{end}}
--- a/cmd/documentation/exchanges_templates/yobit.tmpl
+++ b/cmd/documentation/exchanges_templates/yobit.tmpl
@@ -92,7 +92,5 @@ if err != nil {
 }
 ```

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