Skip to content

chore: add missing type field and add a getting started section #317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
s3bc40 wants to merge 2 commits into
base: main
Choose a base branch
from
+18 −0
Open

chore: add missing type field and add a getting started section #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f1c899
fix: add missing type field in .mcp.json
s3bc40 Apr 24, 2026
e427fb8
docs: add getting started section to CONTRIBUTING.md
s3bc40 Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .mcp.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"mcpServers": {
"CodSpeed": {
"type": "http",
"url": "https://mcp.codspeed.io/mcp"
}
}
Expand Down
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# Contributing to CodSpeed Runner

## Getting Started

### Prerequisites

- [Rust](https://rustup.rs/)
- [Git LFS](https://github.com/git-lfs/git-lfs/blob/main/INSTALLING.md) (required for test fixtures)

### Setup

After cloning the repository, initialize the submodules and fetch the test fixtures:

```bash
git submodule update --init --recursive
git lfs install
git lfs pull
```

## Release Process

This repository is a Cargo workspace containing multiple crates. The release process differs depending on which crate you're releasing.
Expand Down