Skip to content

Commit f13e9cf

Browse files
committed
docs: start writing 1.0 documentation
1 parent 5c4c7e0 commit f13e9cf

File tree

6 files changed

+207
-188
lines changed

6 files changed

+207
-188
lines changed

website/docs/contributing.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,19 @@ The Accounts project was intended - since its inception - to be a community main
1818
## Development
1919

2020
- [Install Node.js](https://nodejs.org/en/download/).
21-
- [Install pnpm](https://pnpm.io/installation).
21+
- This project uses yarn/berry, so you will need to install it, preferably by enabling corepack:
22+
23+
```
24+
corepack enable
25+
```
2226

2327
#### Useful Commands:
2428

25-
- Install project dependencies: `pnpm install`
26-
- Compile the packages `pnpm run compile`
27-
- Watch the packages for changes and recompile: `pnpm run start` (You need to run this command in the package subfolder you are updating)
28-
- Run `docker-compose up -d` to start database services required for tests.
29-
- Run `pnpm run test` to run all the tests.
29+
- Install project dependencies: `yarn install`
30+
- Compile the packages `yarn run compile`
31+
- Watch the packages for changes and recompile: `yarn workspace @accounts/packagename run start`
32+
- Run `docker compose up -d` to start database services required for tests.
33+
- Run `yarn run test` to run all the tests (`yarn workspace @accounts/packagename run test` to run tests for a certain package).
3034

3135
## Pull Requests
3236

@@ -37,15 +41,15 @@ Alternatively, prepend your PR title with `[discuss]` to have a conversation aro
3741

3842
#### All PRs:
3943

40-
1. Must not break the **test suite** (`pnpm run test`), nor reduce **test coverage** (`pnpm run coverage`). If you're fixing a bug, include a test that would fail without your fix.
44+
1. Must not break the **test suite** (`yarn run test`), nor reduce **test coverage** (`yarn run coverage`). If you're fixing a bug, include a test that would fail without your fix. Also ensure that **all** examples still work as expected.
4145

42-
2. Must respect the **.eslintrc.js** (`pnpm run test:lint`). Ideally your editor supports `eslint`. Especially since the project is quite new, feel free to query default rules with us that don't make sense, or disable rules in a particular scope when it makes sense, together with a comment explaining why.
46+
2. Must respect the **.eslintrc.js** (`yarn run test:lint`). Ideally your editor supports `eslint`. Especially since the project is quite new, feel free to query default rules with us that don't make sense, or disable rules in a particular scope when it makes sense, together with a comment explaining why.
4347

4448
3. Must be **isolated**. Avoid grouping many, unrelated changes in a single PR.
4549

4650
4. GitHub now allows auto-squashing of commits in a PR, so no need to rebase your commits before final submission.
4751

48-
5. Must contain a changeset file describing the changes and affected packages. Run `pnpx changeset` to generate one.
52+
5. Must contain a changeset file describing the changes and affected packages. Run `yarn changeset` to generate one.
4953

5054
### Submission
5155

website/docs/databases/mikro-orm.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
id: mikro-orm
3+
title: MikroORM
4+
sidebar_label: MikroORM
5+
---
6+
7+
Placeholder.

0 commit comments

Comments
 (0)