Skip to content

Commit 949e38a

Browse files
committed
Updated some .md files and license
1 parent 15f570d commit 949e38a

4 files changed

Lines changed: 30 additions & 156 deletions

File tree

CONTRIBUTING.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1-
# Contributing to OpenCode
1+
# Contributing to Mammouth Code
22

3-
We want to make it easy for you to contribute to OpenCode. Here are the most common type of changes that get merged:
3+
> [!IMPORTANT]
4+
> Before contributing, please read the section below carefully. Mammouth Code is a fork of OpenCode, and it's important to understand which project your contribution belongs to.
5+
6+
First, we want to make it clear that Mammouth Code is a open fork of the open source OpenCode project. We are building on top of OpenCode and contributing back to it, but we are not affiliated with the OpenCode project or its maintainers in any way. We have our own roadmap and vision for Mammouth Code, which may diverge from OpenCode over time.
7+
8+
Please, before contributing, take a moment to think if your contribution is something that belongs in Mammouth Code specifically, or if it is a more general improvement that would benefit the entire OpenCode ecosystem. If it's the latter, we encourage you to contribute to OpenCode directly. To do so, checkout the [OpenCode repository](https://github.com/anomalyco/opencode) and follow their contributing guidelines. If it's the former, we welcome your contribution to Mammouth Code!
9+
10+
We want to make it easy for you to contribute to Mammouth Code. Here are the most common type of changes that get merged:
411

512
- Bug fixes
613
- Additional LSPs / Formatters
@@ -14,17 +21,17 @@ However, any UI or core product feature must go through a design review with the
1421

1522
If you are unsure if a PR would be accepted, feel free to ask a maintainer or look for issues with any of the following labels:
1623

17-
- [`help wanted`](https://github.com/anomalyco/opencode/issues?q=is%3Aissue%20state%3Aopen%20label%3Ahelp-wanted)
18-
- [`good first issue`](https://github.com/anomalyco/opencode/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22)
19-
- [`bug`](https://github.com/anomalyco/opencode/issues?q=is%3Aissue%20state%3Aopen%20label%3Abug)
20-
- [`perf`](https://github.com/anomalyco/opencode/issues?q=is%3Aopen%20is%3Aissue%20label%3A%22perf%22)
24+
- [`help wanted`](https://github.com/mammouth-ai/code/issues?q=is%3Aissue%20state%3Aopen%20label%3Ahelp-wanted)
25+
- [`good first issue`](https://github.com/mammouth-ai/code/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22)
26+
- [`bug`](https://github.com/mammouth-ai/code/issues?q=is%3Aissue%20state%3Aopen%20label%3Abug)
27+
- [`perf`](https://github.com/mammouth-ai/code/issues?q=is%3Aopen%20is%3Aissue%20label%3A%22perf%22)
2128

2229
> [!NOTE]
2330
> PRs that ignore these guardrails will likely be closed.
2431
2532
Want to take on an issue? Leave a comment and a maintainer may assign it to you unless it is something we are already working on.
2633

27-
## Developing OpenCode
34+
## Developing Mammouth Code
2835

2936
- Requirements: Bun 1.3+
3037
- Install dependencies and start the dev server from the repo root:
@@ -36,13 +43,13 @@ Want to take on an issue? Leave a comment and a maintainer may assign it to you
3643

3744
### Running against a different directory
3845

39-
By default, `bun dev` runs OpenCode in the `packages/opencode` directory. To run it against a different directory or repository:
46+
By default, `bun dev` runs Mammouth Code in the `packages/opencode` directory. To run it against a different directory or repository:
4047

4148
```bash
4249
bun dev <directory>
4350
```
4451

45-
To run OpenCode in the root of the opencode repo itself:
52+
To run Mammouth Code in the root of the code repo itself:
4653

4754
```bash
4855
bun dev .
@@ -59,7 +66,7 @@ To compile a standalone executable:
5966
Then run it with:
6067

6168
```bash
62-
./packages/opencode/dist/opencode-<platform>/bin/opencode
69+
./packages/opencode/dist/opencode-<platform>/bin/mammouth
6370
```
6471

6572
Replace `<platform>` with your platform (e.g., `darwin-arm64`, `linux-x64`).
@@ -71,9 +78,9 @@ Replace `<platform>` with your platform (e.g., `darwin-arm64`, `linux-x64`).
7178
- `packages/desktop`: The native desktop app, built with Tauri (wraps `packages/app`)
7279
- `packages/plugin`: Source for `@opencode-ai/plugin`
7380

74-
### Understanding bun dev vs opencode
81+
### Understanding bun dev vs mammouth
7582

76-
During development, `bun dev` is the local equivalent of the built `opencode` command. Both run the same CLI interface:
83+
During development, `bun dev` is the local equivalent of the built `mammouth` command. Both run the same CLI interface:
7784

7885
```bash
7986
# Development (from project root)
@@ -91,7 +98,7 @@ opencode <directory> # Start TUI in specific directory
9198

9299
### Running the API Server
93100

94-
To start the OpenCode headless API server:
101+
To start the Mammouth Code headless API server:
95102

96103
```bash
97104
bun dev serve
@@ -107,7 +114,7 @@ bun dev serve --port 8080
107114

108115
To test UI changes during development:
109116

110-
1. **First, start the OpenCode server** (see [Running the API Server](#running-the-api-server) section above)
117+
1. **First, start the Mammouth Code server** (see [Running the API Server](#running-the-api-server) section above)
111118
2. **Then run the web app:**
112119

113120
```bash
@@ -154,16 +161,16 @@ Please try to follow the [style guide](./AGENTS.md)
154161

155162
Bun debugging is currently rough around the edges. We hope this guide helps you get set up and avoid some pain points.
156163

157-
The most reliable way to debug OpenCode is to run it manually in a terminal via `bun run --inspect=<url> dev ...` and attach
164+
The most reliable way to debug Mammouth Code is to run it manually in a terminal via `bun run --inspect=<url> dev ...` and attach
158165
your debugger via that URL. Other methods can result in breakpoints being mapped incorrectly, at least in VSCode (YMMV).
159166

160167
Caveats:
161168

162-
- If you want to run the OpenCode TUI and have breakpoints triggered in the server code, you might need to run `bun dev spawn` instead of
169+
- If you want to run the Mammouth Code TUI and have breakpoints triggered in the server code, you might need to run `bun dev spawn` instead of
163170
the usual `bun dev`. This is because `bun dev` runs the server in a worker thread and breakpoints might not work there.
164171
- If `spawn` does not work for you, you can debug the server separately:
165172
- Debug server: `bun run --inspect=ws://localhost:6499/ --cwd packages/opencode ./src/index.ts serve --port 4096`,
166-
then attach TUI with `opencode attach http://localhost:4096`
173+
then attach TUI with `mammouth attach http://localhost:4096`
167174
- Debug TUI: `bun run --inspect=ws://localhost:6499/ --cwd packages/opencode --conditions=browser ./src/index.ts`
168175

169176
Other tips and tricks:
@@ -178,7 +185,7 @@ If you use VSCode, you can use our example configurations [.vscode/settings.exam
178185
Some debug methods that can be problematic:
179186

180187
- Debug configurations with `"request": "launch"` can have breakpoints incorrectly mapped and thus unusable
181-
- The same problem arises when running OpenCode in the VSCode `JavaScript Debug Terminal`
188+
- The same problem arises when running Mammouth Code in the VSCode `JavaScript Debug Terminal`
182189

183190
With that said, you may want to try these methods, as they might work for you.
184191

@@ -257,7 +264,7 @@ These are not strictly enforced, they are just general guidelines:
257264

258265
## Feature Requests
259266

260-
For net-new functionality, start with a design conversation. Open an issue describing the problem, your proposed approach (optional), and why it belongs in OpenCode. The core team will help decide whether it should move forward; please wait for that approval instead of opening a feature PR directly.
267+
For net-new functionality, start with a design conversation. Open an issue describing the problem, your proposed approach (optional), and why it belongs in Mammouth Code. The core team will help decide whether it should move forward; please wait for that approval instead of opening a feature PR directly.
261268

262269
## Trust & Vouch System
263270

@@ -266,7 +273,7 @@ This project uses [vouch](https://github.com/mitchellh/vouch) to manage contribu
266273
### How it works
267274

268275
- **Vouched users** are explicitly trusted contributors.
269-
- **Denounced users** are explicitly blocked. Issues and pull requests from denounced users are automatically closed. If you have been denounced, you can request to be unvouched by reaching out to a maintainer on [Discord](https://opencode.ai/discord)
276+
- **Denounced users** are explicitly blocked. Issues and pull requests from denounced users are automatically closed. If you have been denounced, you can request to be unvouched by reaching out to a maintainer on [Discord](https://discord.gg/YJg2kX77M3)
270277
- **Everyone else** can participate normally — you don't need to be vouched to open issues or PRs.
271278

272279
### For maintainers

LICENSE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
MIT License
22

33
Copyright (c) 2025 opencode
4+
Copyright (c) 2025 Mammouth AI
45

56
Permission is hereby granted, free of charge, to any person obtaining a copy
67
of this software and associated documentation files (the "Software"), to deal

README.bs.md

Lines changed: 0 additions & 136 deletions
This file was deleted.

SECURITY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Security
22

3+
This security file is unrelated to the changes that Mammouth AI made to this fork of OpenCode. It's provided here as is, straight from the original OpenCode repository, for your reference. For any questions about the security of OpenCode, please refer to the original OpenCode repository and its maintainers.
4+
35
## Threat Model
46

57
### Overview

0 commit comments

Comments
 (0)