Skip to content

Commit db12d80

Browse files
authored
docs: adding oxygen to contributing docs (#1076)
- adds oxygen sdk to repo organization section of contributing docs - adds agents rules to prefer opening draft prs <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Adds documentation updates to improve repo guidance and accuracy. > > - Updates `CONTRIBUTING.md` repo diagram to include `shopify-oxygen` and its dependency on `sdk-server` > - Adds PR workflow rule in `.cursor/rules/development.mdc` to open PRs as Draft by default > - Minor cleanup in `.cursor/rules/testing.mdc` (removes stray lines) > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 3b0df7b. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent 072674b commit db12d80

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

.cursor/rules/development.mdc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,6 @@ alwaysApply: true
2828
```
2929
- Replace package name as needed
3030
- Running `yarn build` in individual packages won't rebuild dependencies
31+
32+
## Opening pull requests
33+
- When creating a Pull Request, always create it as a Draft Pull Request unless explicitly instructed otherwise.

.cursor/rules/testing.mdc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,3 @@ alwaysApply: true
4848
- Tests should be run using `yarn workspace <package name> test`
4949
- The package name can be found in the package.json file
5050
- Unit tests should be run for any packages that have been modified
51-
52-

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ flowchart LR
164164
server-ai[sdk/server-ai]
165165
react-universal[sdk/react-universal]
166166
svelte[sdk/svelte]
167+
shopify-oxygen[sdk/shopify-oxygen]
167168

168169
%% Store packages
169170
redis[store/node-server-sdk-redis]
@@ -191,6 +192,7 @@ flowchart LR
191192

192193
sdk-server --> server-node
193194
sdk-server --> server-ai
195+
sdk-server --> shopify-oxygen
194196

195197
sdk-server-edge --> cloudflare
196198
sdk-server-edge --> fastly

0 commit comments

Comments
 (0)