8000 docs: add backend contributing guide by mtojek · Pull Request #18077 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

docs: add backend contributing guide #18077

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

Merged
merged 32 commits into from
May 30, 2025
Merged

docs: add backend contributing guide #18077

Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
ba40049
Quickstart
mtojek May 27, 2025
2369345
Platform Architecture
mtojek May 27, 2025
f3bca2a
Coder libraries
mtojek May 27, 2025
2eb56dd
fix libs
mtojek May 27, 2025
5d27d51
Repository Structure WIP
mtojek May 28, 2025
1b2eeaa
Repository Structure WIP
mtojek May 28, 2025
a18e994
Repository Structure WIP
mtojek May 28, 2025
fd44753
Repository Structure WIP
mtojek May 28, 2025
9bb61e4
Repository Structure WIP
mtojek May 28, 2025
35a9865
Repository Structure
mtojek May 28, 2025
b73cc9e
quiz
mtojek May 28, 2025
d372181
Testing WIP
mtojek May 28, 2025
5a7311e
WIP
mtojek May 28, 2025
3ee0747
WIP
mtojek May 28, 2025
d8ff123
WIP
mtojek May 28, 2025
2a9d702
WIP
mtojek May 28, 2025
619d31c
manifest.json
mtojek May 28, 2025
6d680eb
fix link
mtojek May 28, 2025
a4ce2c3
fix lint
mtojek May 28, 2025
49311d0
git apply
mtojek May 28, 2025
253c446
PR comments
mtojek May 29, 2025
18d5182
PR comments
mtojek May 29, 2025
0fd7fc9
PR comments
mtojek May 29, 2025
7c644d8
PR comments
mtojek May 29, 2025
4a96505
PR comments
mtojek May 29, 2025
08b8542
fix: dogfood
mtojek May 29, 2025
4251ca8
PR comments
mtojek May 30, 2025
121e38a
fix lint
mtojek May 30, 2025
b3274c8
fix lint
mtojek May 30, 2025
25b9564
move database to backend
mtojek May 30, 2025
90b7199
fix lint
mtojek May 30, 2025
7f6517d
fix links
mtojek May 30, 2025
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
Prev Previous commit
Next Next commit
fix lint
  • Loading branch information
@mtojek
mtojek committed May 28, 2025
commit a4ce2c335f43a009524a7aac94eb72d8ee179691
6 changes: 3 additions & 3 deletions docs/contributing/backend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ git clone https://github.com/coder/coder.git
cd coder
```

2. Run the development script to spin up the local environment:
1. Run the development script to spin up the local environment:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could add a quick explainer what the develop script does to deepen the understanding? (I.e. spins up coderd with embedded postgresql, creates an admin and a member user, prepares an initial template, etc.)

Also, are all of these intentionally 1.?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In theory, Markdown should auto-number, but I think this might only work if the content beneath is indented correctly.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown linter enforces 1.-numbering, so I hope this will work. Once we've finished the technical review, I'll politely ask Edward to verify.


```sh
./scripts/develop.sh
Expand All @@ -35,7 +35,7 @@ This will start two processes:
* http://localhost:3000 — the backend API server, used primarily for backend development.
* http://localhost:8080 — the Node.js frontend dev server, useful if you're also touching frontend code.

3. Verify Your Session
1. Verify Your Session

Confirm that you're logged in by running:

Expand All @@ -45,7 +45,7 @@ Confirm that you're logged in by running:

This should return an empty list of workspaces. If you encounter an error, review the output from the [develop.sh](https://github.com/coder/coder/blob/main/scripts/develop.sh) script for issues.

4. Create a Quick Workspace
1. Create a Quick Workspace

A template named docker-amd64 (or docker-arm64 on ARM systems) is created automatically. To spin up a workspace quickly, use:

Expand Down
Loading
0