GitHub

Where the code lives, and how to move it

One public repository, one MIT licence, and a strong preference for small changes that arrive with a failing test. This page is the map; the repository itself is the territory.

The repository

github.com/Arjuunb/nexus-trading-bot, default branch main. The areas you are most likely to want:

Filing an issue that gets fixed

Maintainer time goes to issues that can be reproduced. Everything below exists to make that possible in one round trip rather than four.

What to include

The commit or client version, the exact call or configuration, what you expected, what happened, and a decision or backtest id if one is involved — the decision record holds the rule that fired and the reason it gave. The issue form asks for each.

What to leave out

API keys, exchange credentials, account identifiers and full log dumps. Redact before pasting. A public issue is public immediately and permanently.
a good issue
### What happened
`POST /v1/backtests` for `donchian` on ETHUSDT 1h returns 202,
then the job sits in `queued` indefinitely.

### Expected
The job moves to `running` within a few seconds, as it does
for BTCUSDT 15m.

### Reproduce
- client: tradelogx-nexus 0.1.0, Python 3.12
- backtest id: bt_2f77a1c09e4d
- body: { "strategy": "donchian", "symbol": "ETHUSDT", "timeframe": "1h", "bars": 800 }

### Notes
Same result from curl, so it looks server-side.

Security issues never go in a public issue. A vulnerability in a trading system with connected exchange keys is not something to disclose in a tracker while it is unpatched. Report it privately through GitHub's Report a vulnerability form on the repository; SECURITY.md has the details.

Pull requests

One change per pull request. A branch that fixes a bug and also renames three files is two reviews wearing one hat.

  1. 1Open an issue first for anything larger than a fix — agreeing on the approach costs a comment and saves a rewrite.
  2. 2Add a test that fails before the change and passes after. For anything that can block or place a trade this is not optional.
  3. 3Keep the diff readable. Formatting changes belong in their own commit, and preferably their own pull request.
  4. 4CI must be green: the engine and platform suites, both front-end builds and all four SDK suites run on every push.
  5. 5The maintainer reviews every pull request in public. There is no CLA; contributions are under the repository's MIT licence.

Releases

How changes ship

The platform deploys from the repository with scripts/deploy.sh. There are no tagged releases yet, and the SDKs are not published to package registries — they install from the repository at the commit you choose.

A platform deploy does not change what an existing client parses: response shapes are pinned by the Nexus-Version header, described on the API reference.

Open the repository on GitHub