You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+27-20Lines changed: 27 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,13 @@
1
-
# Contributing to OpenCode
1
+
# Contributing to Mammouth Code
2
2
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:
4
11
5
12
- Bug fixes
6
13
- Additional LSPs / Formatters
@@ -14,17 +21,17 @@ However, any UI or core product feature must go through a design review with the
14
21
15
22
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:
then attach TUI with `opencode attach http://localhost:4096`
173
+
then attach TUI with `mammouth attach http://localhost:4096`
167
174
- Debug TUI: `bun run --inspect=ws://localhost:6499/ --cwd packages/opencode --conditions=browser ./src/index.ts`
168
175
169
176
Other tips and tricks:
@@ -178,7 +185,7 @@ If you use VSCode, you can use our example configurations [.vscode/settings.exam
178
185
Some debug methods that can be problematic:
179
186
180
187
- 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`
182
189
183
190
With that said, you may want to try these methods, as they might work for you.
184
191
@@ -257,7 +264,7 @@ These are not strictly enforced, they are just general guidelines:
257
264
258
265
## Feature Requests
259
266
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.
261
268
262
269
## Trust & Vouch System
263
270
@@ -266,7 +273,7 @@ This project uses [vouch](https://github.com/mitchellh/vouch) to manage contribu
266
273
### How it works
267
274
268
275
-**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)
270
277
-**Everyone else** can participate normally — you don't need to be vouched to open issues or PRs.
Copy file name to clipboardExpand all lines: SECURITY.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# Security
2
2
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.
0 commit comments