Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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.

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

Already on GitHub?Sign in to your account

Merged
mtojek merged 32 commits intomainfromdocs-backend-contrib-guide
May 30, 2025
Merged

Conversation

mtojek
Copy link
Member

@mtojekmtojek commentedMay 28, 2025
edited
Loading

Preview:https://github.com/coder/coder/blob/docs-backend-contrib-guide/docs/contributing/backend.md

This PR introduces the foundation for a backend contributing page aimed at new contributors who are unfamiliar with Coder's codebase.

The goal is to provide a smooth onboarding experience where a fresh developer can spend 15–30 minutes and walk away with a basic understanding of the backend architecture, tooling, and workflows.

Included sections

  • Quickstart: a guide to set up a local backend dev environment
  • Tech Stack and Libraries
  • Repository Structure: explanation of key directories and their responsibilities
  • Testing Utilities: summary of Go testing helpers available in the codebase
  • Quiz: Essential questions every contributor should be able to answer before jumping into implementation

@mtojekmtojek self-assigned thisMay 28, 2025
@mtojekmtojek marked this pull request as ready for reviewMay 28, 2025 15:34
Copy link
Member

@mafredrimafredri left a comment

Choose a reason for hiding this comment

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

This is a really solid doc, lots of good info packed in, nice work! Left some comments inline.

cd coder
```

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 intentionally1.?

mtojek and ssncferreira reacted with thumbs up emoji
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, Markdownshould auto-number, but I think this might only work if the content beneath is indented correctly.

Copy link
MemberAuthor

Choose a reason for hiding this comment

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

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


## Repository Structure

The Coder backend is organized into multiple packages and directories, each with a specific purpose. Here's a high-level overview of the most important ones:
Copy link
Member

Choose a reason for hiding this comment

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

Great detail! Wdyt about adding a key areas of interest section under here as well, just so people scanning this can get a better idea of what's themost important. Maybe point out agent, coderd, queries, provisioner for instance.

Copy link
MemberAuthor

@mtojekmtojekMay 29, 2025
edited
Loading

Choose a reason for hiding this comment

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

Maybe point out agent, coderd, queries, provisioner for instance.

I'm intrigued! Do you have something specific in mind? Should I move up the most important ones?

Copy link
Member

Choose a reason for hiding this comment

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

I think that's a great idea! Let's iterate on this further in future PRs.

Copy link
Member

@johnstcnjohnstcn left a comment

Choose a reason for hiding this comment

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

Great work@mtojek ! Let's keep iterating on this.

@mtojekmtojek requested a review fromEdwardAngertMay 29, 2025 11:45
@mtojek
Copy link
MemberAuthor

mtojek commentedMay 29, 2025
edited
Loading

@EdwardAngert shall I ask you to verify if the new page is consistent with our docbase? There are a lot of link references, and I hope our doc renderer can handle those.

EdwardAngert reacted with heart emoji

Copy link
Contributor

@ssncferreirassncferreira left a comment

Choose a reason for hiding this comment

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

This is a really great addition 🚀 just added a couple of comments for consideration

mtojek reacted with rocket emoji
Copy link
Member

@matifalimatifali left a comment

Choose a reason for hiding this comment

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

LGTM now.

@EdwardAngert
Copy link
Contributor

considering where this is, don't wait on my review - I want to work my way through the steps, which might take a little while. I can add edits as I go

mtojek reacted with heart emoji

@mtojekmtojek merged commit1fba419 intomainMay 30, 2025
34 checks passed
@mtojekmtojek deleted the docs-backend-contrib-guide branchMay 30, 2025 14:24
@github-actionsgithub-actionsbot locked and limited conversation to collaboratorsMay 30, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@johnstcnjohnstcnjohnstcn approved these changes

@matifalimatifalimatifali approved these changes

@mafredrimafredriAwaiting requested review from mafredri

@EdwardAngertEdwardAngertAwaiting requested review from EdwardAngert

@ssncferreirassncferreiraAwaiting requested review from ssncferreira

Assignees

@mtojekmtojek

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

6 participants
@mtojek@EdwardAngert@mafredri@johnstcn@ssncferreira@matifali

[8]ページ先頭

©2009-2025 Movatter.jp