Skip to content

Conversation

cranktakular
Copy link
Collaborator

PR Description

Fixing some oddities I encountered when implementing Bitget.

There are some other oddities I've spotted that I'm not equipped to handle:

  • Most exchange templates claim that the exchange supports an "e.Trade()" function, but that only exists for Yobit; I'm not sure which replacement example I should plop in.
  • WS_ORDER_EVENTS.md is outdated, but it requires knowledge of how mandatory/optional our new fields are, which I don't have.
  • Instructions for gctcli's usage in ADD_NEW_EXCHANGE.md and its own README.md file are insufficient for me to understand it. Since I don't really get it, I can't add in the instructions myself.
  • Some wrapper functions aren't part of the wrapper template, and I'm not sure how which ones ought to be.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested

No tests were done, as this was largely changing documentation, with biggest changes being minor functional template tweaks.

  • go test ./... -race
  • golangci-lint run
  • Test X

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation and regenerated documentation via the documentation tool
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally and on Github Actions with my changes
  • Any dependent changes have been merged and published in downstream modules

@Copilot Copilot AI review requested due to automatic review settings August 19, 2025 08:07
@cranktakular cranktakular added the review me This pull request is ready for review label Aug 19, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR fixes grammatical errors and improves documentation across exchange wrapper templates and documentation files. The main purpose is to correct a repeated typo where comments incorrectly stated "Submits an order and the exchange" instead of "Submits an order to the exchange".

Key changes:

  • Corrects grammatical error in order submission comments across all exchange documentation
  • Updates wrapper template with improved pair format examples
  • Modernizes documentation references and terminology

Reviewed Changes

Copilot reviewed 51 out of 51 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
Multiple exchange README.md files Fixed grammatical error in order submission comment
Multiple exchange template files Fixed same grammatical error in documentation templates
cmd/exchange_template/wrapper.tmpl Updated pair format examples with delimiters
docs/ADD_NEW_EXCHANGE.md Updated GitHub link and improved code examples
cmd/documentation/root_templates/root_readme.tmpl Changed "Streaming API" to "Websocket" in table header
README.md Updated exchange support table header and contributor statistics
CONTRIBUTORS Updated contributor ordering

@@ -319,7 +305,7 @@ Modify existing constants or create new ones to define the API URL paths, as app
apiURL = "https://api.binance.com"
```

Create a get function in `rest.go` file and unmarshall the data in the created type:
Create a get function in the `rest.go` file and unmarshal the data in the created type:
Copy link
Preview

Copilot AI Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The word 'unmarshall' should be 'unmarshal' (single 'l').

Copilot uses AI. Check for mistakes.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is why I am changing it Copilot sir.

Copy link

codecov bot commented Aug 19, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 39.78%. Comparing base (7879633) to head (b24be60).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2009      +/-   ##
==========================================
- Coverage   39.78%   39.78%   -0.01%     
==========================================
  Files         433      433              
  Lines      172030   172030              
==========================================
- Hits        68446    68437       -9     
- Misses      96446    96457      +11     
+ Partials     7138     7136       -2     

see 12 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@thrasher- thrasher- changed the title cmd/exchange_template: Updating wrapper template, improving documentation cmd/exchange_template: Update wrapper template, improve documentation Aug 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review me This pull request is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant