Skip to content

Commit 71f3c8a

Browse files
committed
docs: update contributing guidelines and README for contribution support and provider details
- Announce support for contributions in `CONTRIBUTING.md`. - Simplify and adjust submission guidelines, emphasizing focus and project alignment. - Update README with new provider details, including Claude Code as the default provider. - Add prerequisites for provider CLIs and git host integration in documentation.
1 parent 3be99e4 commit 71f3c8a

4 files changed

Lines changed: 47 additions & 48 deletions

File tree

.docs/codex-prerequisites.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
1-
# Codex prerequisites
1+
# Provider prerequisites
22

3-
- Install Codex CLI so `codex` is on your PATH.
3+
MarCode requires at least one of the following coding agent CLIs installed and authorized:
4+
5+
## Claude Code CLI (default provider)
6+
7+
- Install [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code) so `claude` is on your PATH.
8+
- Authenticate before running MarCode.
9+
10+
## Codex CLI
11+
12+
- Install [Codex CLI](https://github.com/openai/codex) so `codex` is on your PATH.
413
- Authenticate Codex before running MarCode (for example via API key or ChatGPT auth supported by Codex).
5-
- MarCode starts the server via `codex app-server` per session.
14+
- MarCode starts the server via `codex app-server` per Codex session.
15+
16+
## Git host CLIs (optional, for PR/MR features)
17+
18+
- **GitHub:** Install and authenticate [GitHub CLI (`gh`)](https://cli.github.com/).
19+
- **GitLab:** Install and authenticate [GitLab CLI (`glab`)](https://gitlab.com/gitlab-org/cli). A Personal Access Token works for self-hosted instances.

.docs/provider-architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Methods mirror the `NativeApi` interface defined in `@marcode/contracts`:
1313
- `providers.respondToRequest`, `providers.stopSession`
1414
- `shell.openInEditor`, `server.getConfig`
1515

16-
Codex is the only implemented provider. `claudeCode` is reserved in contracts/UI.
16+
Claude Code is the default provider. Codex is also supported as an alternative provider.
1717

1818
## Client transport
1919

CONTRIBUTING.md

Lines changed: 11 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
# Contributing
22

3-
## Read This First
4-
5-
We are not actively accepting contributions right now.
6-
7-
You can still open an issue or PR, but please do so knowing there is a high chance we close it, defer it forever, or never look at it.
8-
9-
If that sounds annoying, that is because it is. This project is still early and we are trying to keep scope, quality, and direction under control.
3+
We welcome contributions! MarCode is still early, so please read the guidelines below to keep things smooth.
104

115
PRs are automatically labeled with a `vouch:*` trust status and a `size:*` diff size based on changed lines.
126

@@ -16,31 +10,25 @@ If you are an external contributor, expect `vouch:unvouched` until we explicitly
1610

1711
Small, focused bug fixes.
1812

19-
Small reliability fixes.
20-
21-
Small performance improvements.
13+
Reliability and performance improvements.
2214

2315
Tightly scoped maintenance work that clearly improves the project without changing its direction.
2416

25-
## What We Are Least Likely To Accept
17+
New integrations or features that align with the project's goals (discuss in an issue first).
2618

27-
Large PRs.
19+
## What We Are Least Likely To Accept
2820

29-
Drive-by feature work.
21+
Large, unfocused PRs that mix unrelated changes.
3022

31-
Opinionated rewrites.
23+
Opinionated rewrites without prior discussion.
3224

3325
Anything that expands product scope without us asking for it first.
3426

35-
If you open a 1,000+ line PR full of new features, we will probably close it quickly and remember that you ignored the clearly written instructions.
36-
37-
## If You Still Want To Open A PR
38-
39-
Keep it small.
27+
## Opening A PR
4028

41-
Explain exactly what changed.
29+
Keep it small and focused.
4230

43-
Explain exactly why the change should exist.
31+
Explain exactly what changed and why the change should exist.
4432

4533
Do not mix unrelated fixes together.
4634

@@ -54,12 +42,8 @@ If we have to guess what changed, we are much less likely to review it.
5442

5543
If you are thinking about a non-trivial change, open an issue first.
5644

57-
That still does not mean we will want the PR, but it gives you a chance to avoid wasting your time.
45+
This gives you a chance to align with the project direction before investing time.
5846

5947
## Be Realistic
6048

61-
Opening a PR does not create an obligation on our side.
62-
63-
We may close it. We may ignore it. We may ask you to shrink it. We may reimplement the idea ourselves later.
64-
65-
If you are fine with that, proceed.
49+
We may close, defer, or ask you to rework a PR. We may also reimplement the idea ourselves later. That's the nature of early-stage projects — please don't take it personally.

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,29 @@
11
# MarCode
22

3-
MarCode is a minimal web GUI for coding agents (currently Codex and Claude, more coming soon).
3+
MarCode is a web GUI for coding agents, built as a rebrand and major evolution of [T3 Code](https://github.com/t3dotgg/t3code). On top of the original foundation, MarCode brings performance optimizations, new integrations, and a refined experience:
44

5-
## How to use
6-
7-
> [!WARNING]
8-
> You need to have [Codex CLI](https://github.com/openai/codex) installed and authorized for MarCode to work.
9-
10-
```bash
11-
npx marcode
12-
```
5+
- **Claude Code CLI** as the default and primary provider
6+
- **Jira Cloud integration** (OAuth 2.0, sprint browsing, `@PROJ-123` mentions in composer)
7+
- **GitLab support** alongside GitHub (auto-detected from remote origin)
8+
- **Preview diff display** for proposed file changes
9+
- **Incremental state updates** for smooth, non-blocking UI during agent work
10+
- **Additional directories in composer** — add extra directories to agent context per thread
11+
- And much more
1312

14-
You can also just install the desktop app. It's cooler.
13+
## How to use
1514

16-
Install the [desktop app from the Releases page](https://github.com/tyulyukov/marcode/releases)
15+
### Prerequisites
1716

18-
## Some notes
17+
You need at least one of the following coding agent CLIs installed and authorized:
1918

20-
We are very very early in this project. Expect bugs.
19+
- [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code)
20+
- [Codex CLI](https://github.com/openai/codex)
2121

22-
We are not accepting contributions yet.
22+
For git host integration:
2323

24-
## If you REALLY want to contribute still.... read this first
24+
- **PRs (GitHub):** [GitHub CLI (`gh`)](https://cli.github.com/) installed and authenticated
25+
- **MRs (GitLab):** [GitLab CLI (`glab`)](https://gitlab.com/gitlab-org/cli) installed and authenticated (Personal Access Token works for self-hosted instances)
2526

26-
Read [CONTRIBUTING.md](./CONTRIBUTING.md) before opening an issue or PR.
27+
### Via Desktop App
2728

28-
Need support? Join the [Discord](https://discord.gg/jn4EGJjrvv).
29+
Install the [desktop app from the Releases page](https://github.com/tyulyukov/marcode/releases)

0 commit comments

Comments
 (0)