docs: add backend contributing guide #18077
Conversation
docs/contributing/backend.md
Outdated
| cd coder | ||
| ``` | ||
|
|
||
| 1. Run the development script to spin up the local environment: |
There was a problem hiding this comment.
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.?
There was a problem hiding this comment.
In theory, Markdown should auto-number, but I think this might only work if the content beneath is indented correctly.
There was a problem hiding this comment.
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.
|
|
||
| ## 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: |
There was a problem hiding this comment.
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 the most important. Maybe point out agent, coderd, queries, provisioner for instance.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
I think that's a great idea! Let's iterate on this further in future PRs.
|
@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. |
|
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 |
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