Skip to content

chore: improve content of frontend contributing guide #14619

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 4 commits into from
Sep 10, 2024
Merged

chore: improve content of frontend contributing guide #14619

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
22c7755
chore: update frontend contributing guide
jaaydenh Sep 9, 2024
c789c14
chore: cleanup language
jaaydenh Sep 9, 2024
f92310a
chore: cleanup
jaaydenh Sep 9, 2024
f371fe5
chore: updates for comments
jaaydenh Sep 10, 2024
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
chore: updates for comments
  • Loading branch information
@jaaydenh
jaaydenh committed Sep 10, 2024
commit f371fe594b0d40df8980d7eab8e5c816d06a69e9
5 changes: 4 additions & 1 deletion docs/contributing/frontend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ You can run the UI and access the Coder dashboard in two ways:
In both cases, you can access the dashboard on `http://localhost:8080`. If using
`./scripts/develop.sh` you can log in with the default credentials.

> [!TIP]
>
> **Default Credentials:** `admin@coder.com` and `SomeSecurePassword!`.
Copy link
Member

Choose a reason for hiding this comment

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

nit: this is not quite the GHFM "callout" that @Parkreiner was suggesting, this is just a block quote, which is also kind of a misrepresentation

https://github.com/orgs/community/discussions/16925


## Tech Stack Overview
Expand Down Expand Up @@ -97,7 +99,7 @@ tests for these states with `*.stories.ts` files.

We use [TanStack Query v4](https://tanstack.com/query/v4/docs/react/quick-start)
to fetch data from the API. Queries and mutation should be placed in the
`api/queries` folder.
api/queries folder.

### Where to fetch data

Expand Down Expand Up @@ -237,6 +239,7 @@ module would only make sense in the Coder codebase.
- Component
- Simple
- Atomic, used in multiple places
- Generic, would be useful as a component outside of the Coder product
- Good Examples: `Badge`, `Form`, `Timeline`
- Module
- Simple or Complex
Expand Down
Loading