diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ad87c7..4823ea5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,37 +1,62 @@ # Contributing to Radius Red -We welcome contributions to Radius Red's open source repositories. +Radius Red Ltd. is a UK-based, agentic engineering company. This GitHub +organisation hosts the open-source tools and shared automation we maintain in +public; the [organisation profile](profile/README.md) says how we work. -This repository (`.github`) holds shared GitHub Actions workflows, organisation -profile content, and cross-repo documentation. For project-specific guidance, -refer to the `CONTRIBUTING.md` in each repository: +## What this repository holds -- [`tradedesk`](https://github.com/radiusred/tradedesk) -- [`tradedesk-dukascopy`](https://github.com/radiusred/tradedesk-dukascopy) -- [`tradedesk-miner`](https://github.com/radiusred/tradedesk-miner) +`.github` is the organisation's shared-asset repository. It holds only what +other repositories consume: -## Getting Started +- `.github/workflows/reusable-release.yml` and + `.github/workflows/reusable-finalize-release.yml` — the reusable release + workflows, called by + [`tradedesk`](https://github.com/radiusred/tradedesk) and + [`tradedesk-dukascopy`](https://github.com/radiusred/tradedesk-dukascopy) + from their `prepare-release` and `finalize-release` workflows. +- `.github/actions/calculate_version` — the version-calculation action the + release workflow runs. +- `profile/` — the organisation profile shown at + [github.com/radiusred](https://github.com/radiusred). -1. Fork the repository and create a feature branch from `main`. -2. Install dependencies and run tests locally if applicable. +Beyond those, the repository carries only its own housekeeping: this file, +`.gitignore`, and `.codecrew.yml`, which points CodeCrew coordination for this +repository at the company hub. Each project's documentation lives with the +project. -## Standards +## Contributing to a project -- Keep changes small, well-scoped, and documented in PR descriptions. -- Open PRs against `main`; rebase rather than merge commits. -- Provide a brief rationale and expected impact in the PR description. -- Include tests or updates to tests if the change affects behaviour. -- Do not include secrets or internal data in public PRs. +Contributions are accepted per project. Each project repository carries its +own `README.md` and, where the project takes contributions, a +`CONTRIBUTING.md`; follow those. The current list is at +[github.com/orgs/radiusred/repositories](https://github.com/orgs/radiusred/repositories). +(This repository is not a project: `profile/README.md` is the organisation +profile GitHub shows on the org page, not a repository README, and this file +is its contributing guide.) -## Documentation +If you are unsure whether a change is wanted, open an issue in the repository +concerned describing the goal before writing the code. -- Update public docs with exact references to shipped code. -- Reference merged PRs or docs for traceability. +## Changing this repository -## Reporting Issues +`main` is protected: changes arrive by pull request, history is linear (rebase +only, no merge commits), and commit messages follow +[Conventional Commits](https://www.conventionalcommits.org/). -If unsure about scope or approach, open an issue describing the goal and request -guidance before implementing. +- Callers reference the reusable workflows and the action at `@main`, so a + merge here is live for every caller at once. Say in the PR which callers you + checked, and keep workflow inputs, secrets and outputs backward compatible + or land the callers' change alongside. +- Keep the profile accurate; it is what a visitor to the organisation sees + first. +- Never include secrets or internal data in a public PR. + +## Security + +To report a vulnerability in any Radius Red project, email +[opensource@radiusred.uk](mailto:opensource@radiusred.uk) rather than opening +a public issue. --- @@ -40,4 +65,4 @@ guidance before implementing. Licensed under the Apache License, Version 2.0. See: https://www.apache.org/licenses/LICENSE-2.0 -Copyright 2026 [Radius Red Ltd.](https://github.com/radiusred) +Copyright 2026 [Radius Red Ltd.](https://www.radiusred.uk) diff --git a/_config.yml b/_config.yml deleted file mode 100644 index d407c3f..0000000 --- a/_config.yml +++ /dev/null @@ -1,5 +0,0 @@ -name: radiusred.github.io - -pages: - name: Pages - title: Radius Red Blog diff --git a/doc/radius-red.drawio b/doc/radius-red.drawio deleted file mode 100644 index 9a04e77..0000000 --- a/doc/radius-red.drawio +++ /dev/null @@ -1,560 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 473aef3..0000000 --- a/docs/index.md +++ /dev/null @@ -1,15 +0,0 @@ -# Radius Red - -Open-source algorithmic trading research. We build in public, fail in public, and explain what we find. - -We make systematic trading tools — like [tradedesk](https://github.com/radiusred/tradedesk) — and write about what we learn along the way. - -## Publishing Locations - -**Blog:** Read our posts at [`radiusred/blog`](https://github.com/radiusred/blog) → https://radiusred.github.io/blog/ - -**This site:** Organization docs and profile (radiusred/.github) - ---- - -[GitHub](https://github.com/radiusred) · [Bluesky](https://bsky.app/profile/radiusred.bsky.social) diff --git a/index.html b/index.html deleted file mode 100644 index 15fe57b..0000000 --- a/index.html +++ /dev/null @@ -1,10 +0,0 @@ - - - - Radius Red - - - -

Redirecting to Blog

- - diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 28258b4..0000000 --- a/mkdocs.yml +++ /dev/null @@ -1,43 +0,0 @@ -site_name: Radius Red -site_url: https://radiusred.github.io/.github/ -repo_url: https://github.com/radiusred/.github -repo_name: radiusred/.github - -theme: - name: material - palette: - - scheme: slate - primary: red - accent: red - features: - - navigation.instant - - navigation.tracking - - search.suggest - - search.highlight - - content.code.copy - -plugins: - - search - -nav: - - Home: index.md - -extra: - social: - - icon: fontawesome/brands/github - link: https://github.com/radiusred - - icon: fontawesome/brands/bluesky - link: https://bsky.app/profile/radiusred.bsky.social - -markdown_extensions: - - admonition - - pymdownx.details - - pymdownx.superfences - - pymdownx.highlight: - anchor_linenums: true - - pymdownx.snippets - - pymdownx.tabbed: - alternate_style: true - - attr_list - - toc: - permalink: true diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 4df33c5..0000000 --- a/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -mkdocs-material>=9.5