Skip to content

Commit e6a3a75

Browse files
committed
chore: update contributing docs
1 parent ac072d9 commit e6a3a75

7 files changed

+26
-14
lines changed

contributing/become-a-contributor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Become A Contributor
22

3-
Anyone can contribute to EmberData. Contributing can be as simple as opening an issue or helping to track down the cause of one. Or as involved as contributing a fix, helping with routine maintenance, or implementing a big new feature.
3+
Anyone can contribute to WarpDrive. Contributing can be as simple as opening an issue or helping to track down the cause of one. Or as involved as contributing a fix, helping with routine maintenance, or implementing a big new feature.
44

55
In addition to holding discussions on individual [issues](https://github.com/emberjs/data/issues)
66
or [RFCs](https://github.com/emberjs/rfcs/labels/T-ember-data), we coordinate work when needed in the `#dev-ember-data` channel on [Ember's Discord Server](https://discord.gg/zT3asNS).

contributing/key-concepts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ const identifier = recordIdentifierFor(record);
3333
unloadRecord(identifier);
3434
```
3535

36-
Any identifier supplied by an EmberData API will always be the stable variant. APIs which are operating based on identity and which can reasonably presume that the data exists expect stable identifiers and should error if an unknown identifier is encountered to prevent potential system-correctness errors.
36+
Any identifier supplied by a WarpDrive API will always be the stable variant. APIs which are operating based on identity and which can reasonably presume that the data exists expect stable identifiers and should error if an unknown identifier is encountered to prevent potential system-correctness errors.

contributing/linking-to-applications.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
#### Testing EmberData source directly in your Application
1+
#### Testing WarpDrive source directly in your Application
22

3-
You can use package linking to test checkouts of ember-data against your application locally. This applies to consuming ember-data directly within an ember application. It will not work in your application if you are consuming ember-data through an addon (transitive dependency problem). This approach also presumes consuming all of ember-data.
3+
You can use package linking to test checkouts of WarpDrive against your application locally. This applies to consuming WarpDrive directly within an ember application. It will not work in your application if you are consuming WarpDrive through an addon (transitive dependency problem). This approach also presumes consuming all of WarpDrive.
44

55
1. clone this repository or another fork
66
2. install dependencies: `pnpm install`
@@ -14,4 +14,4 @@ If using `pnpm`
1414

1515
If you don't use pnpm in your application, using the appropriate `yarn link` and `npm link` commands within the respective directories for the project and your app may work.
1616

17-
Once you have linked EmberData to your application, you can run `ember serve` as usual in your application.
17+
Once you have linked WarpDrive to your application, you can run `ember serve` as usual in your application.

contributing/rfc-process.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
### Requesting Features or Deprecations
22

3-
`ember-data` participates in the [RFC process (GitHub emberjs/rfcs)](https://github.com/emberjs/rfcs/).
3+
While WarpDrive is universal in nature, its development is managed by the EmberJS community.
4+
5+
WarpDrive participates in the [RFC process (GitHub emberjs/rfcs)](https://github.com/emberjs/rfcs/).
46
Most changes to the public API including new features, changes in behavior, or deprecations require
57
community discussion and must go through this process.
68

@@ -20,12 +22,12 @@ are narrowly scoped with clear understanding of alternatives, drawbacks, and the
2022
5. Open an [RFC issue](https://github.com/emberjs/rfcs/issues?q=is%3Aissue+is%3Aopen+label%3AT-ember-data)
2123
to broaden and record the discussion if the idea needs more time for discussion and iteration.
2224
- label your issue with `T-ember-data` (or ask someone in `#dev-ember-data` to add the label if you lack the permission)
23-
- announce your issue in `#dev-ember-data` and anywhere else desired such as `#news-and-announcements` and `twitter`.
25+
- announce your issue in `#dev-ember-data` and anywhere else desired such as `#news-and-announcements` and `bluesky`.
2426
6. [Draft an RFC](https://github.com/emberjs/rfcs#what-the-process-is) and share it with those you have
2527
been discussing the ideas with.
2628
7. Publish your RFC by opening a PR to [emberjs/rfcs/](https://github.com/emberjs/rfcs/pulls?q=is%3Apr+is%3Aopen+label%3AT-ember-data)
2729
- label your PR with `T-ember-data` (or ask someone in `#dev-ember-data` to add the label if you lack the permission)
28-
- announce your PR in `#dev-ember-data` and anywhere else desired such as `#news-and-announcements` and `twitter`.
30+
- announce your PR in `#dev-ember-data` and anywhere else desired such as `#news-and-announcements` and `bluesky`.
2931
8. Attend weekly team meetings to discuss the RFC, continue iterating on the RFC, and help shepherd it to completion.
3032
9. Build a proof-of-concept. Sometimes this is best if it occurs alongside drafting the RFC, as it often informs
3133
the RFC design, known drawbacks, and alternatives. Often it will become incorporated in the final implementation.

contributing/setting-up-the-project.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,13 @@ Currently the install command is also what builds all of the individual packages
6868
## Create certificates
6969

7070
```sh
71-
pnpx @warp-drive/holodeck ensure-cert
71+
pnpm dlx @warp-drive/holodeck ensure-cert
7272
```
7373

74+
## Building the project
75+
76+
The project's packages will build whenever `pnpm install` is run.
77+
7478
## Run some commands
7579

7680
Generally test and lint commands can be found in the `"scripts"` section of the root `package.json` manifest. Individual packages or test packages have additional commands in the `"scripts"` section of their own `package.json` manifest as well.

contributing/submitting-prs.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,17 @@ All PRs should have accompanying tests. For bug-fixes, this should include tests
1919
the issue being fixed and test that the solution works.
2020

2121
- We do write tests for our deprecations and assertion messages, using the `assert.expectAssertion()` and `assert.expectDeprecation()` helpers.
22-
- Because we run tests in both development and `production` environments, assertions, deprecations and warnings may be stripped out. To avoid tests on failing for your PR in production environments, use the `testInDebug` function instead of `qunit` `test` to skip them in production when appropriate.
22+
- Because we run tests in both development and `production` environments, assertions, deprecations and warnings may be stripped out. To avoid tests of debug behaviors failing for your PR in production environments, use the `testInDebug` function instead of `qunit` `test` to skip them in production when appropriate.
23+
- alternatively wrap specific assertions in `if (DEBUG)` or `if (PRODUCTION)`
2324
- Update the documentation, examples, and guides when affected by your contribution
2425

2526
### Running Tests
2627

2728
- PRs will automatically run an extensive set of test scenarios for your work. In some cases a contributor
2829
may need to approve the workflow run if this is your first contribution.
29-
- `EmberData` is a collection of packages and comes with multiple test apps scoped to specific situations
30-
or parts of the codebase we want to test. Tests live in the test applications in `<project>/tests`. These should look like familiar ember app/addon tests, and to run them from within a specific test app use `pnpm test` or `pnpm test --serve`. For additional test commands see the list
30+
- `WarpDrive` is a collection of packages and comes with multiple test apps scoped to specific situations
31+
or parts of the codebase we want to test. These test applications can be found in `<project>/tests`.
32+
These should look like familiar ember app/addon tests, and to run them from within a specific test app use `pnpm test` or `pnpm test --serve`. For additional test commands see the list
3133
of commands in the respective `package.json` files.
3234

3335
### Pull Request Titles

packages/holodeck/server/index.js

+6-2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@ async function getCertInfo() {
4343
const KEY = Bun.file(KEY_PATH);
4444

4545
if (!(await CERT.exists()) || !(await KEY.exists())) {
46-
throw new Error('SSL certificate or key not found, you may need to run `pnpx @warp-drive/holodeck ensure-cert`');
46+
throw new Error(
47+
'SSL certificate or key not found, you may need to run `pnpm dlx @warp-drive/holodeck ensure-cert`'
48+
);
4749
}
4850

4951
return {
@@ -54,7 +56,9 @@ async function getCertInfo() {
5456
};
5557
} else {
5658
if (!fs.existsSync(CERT_PATH) || !fs.existsSync(KEY_PATH)) {
57-
throw new Error('SSL certificate or key not found, you may need to run `pnpx @warp-drive/holodeck ensure-cert`');
59+
throw new Error(
60+
'SSL certificate or key not found, you may need to run `pnpm dlx @warp-drive/holodeck ensure-cert`'
61+
);
5862
}
5963

6064
return {

0 commit comments

Comments
 (0)