Add js-sdk to resolutions in local development section (#14197)
## Summary
**What** — What changes are introduced in this PR?
*Please provide answer here*
**Why** — Why are these changes relevant or necessary?
*Please provide answer here*
**How** — How have these changes been implemented?
*Please provide answer here*
**Testing** — How have these changes been tested, or how can the reviewer test the feature?
*Please provide answer here*
---
## Examples
Provide examples or code snippets that demonstrate how this feature works, or how it can be used in practice.
This helps with documentation and ensures maintainers can quickly understand and verify the change.
```ts
// Example usage
```
---
## Checklist
Please ensure the following before requesting a review:
- [ ] I have added a **changeset** for this PR
- Every non-breaking change should be marked as a **patch**
- To add a changeset, run `yarn changeset` and follow the prompts
- [ ] The changes are covered by relevant **tests**
- [ ] I have verified the code works as intended locally
- [ ] I have linked the related issue(s) if applicable
---
## Additional Context
Add any additional context, related issues, or references that might help the reviewer understand this PR.
This commit is contained in:
Nicolas Gorga
GitHub
@@ -5,6 +5,7 @@ Thank you for considering contributing to Medusa! This document will outline how
|
||||
If you're contributing to our documentation, make sure to also check out the [contribution guidelines on our documentation website](https://docs.medusajs.com/resources/contribution-guidelines/docs).
|
||||
|
||||
### Important
|
||||
|
||||
Our core maintainers prioritize pull requests (PRs) from within our organization. External contributions are regularly triaged, but not at any fixed cadence. It varies depending on how busy the maintainers are. This is applicable to all types of PRs, so we kindly ask for your patience.
|
||||
|
||||
If you, as a community contributor, wish to work on more extensive features, please reach out to CODEOWNERS instead of directly submitting a PR with all the changes. This approach saves us both time, especially if the PR is not accepted (which will be the case if it does not align with our roadmap), and helps us effectively review and evaluate your contribution if it is accepted.
|
||||
@@ -26,11 +27,10 @@ If you, as a community contributor, wish to work on more extensive features, ple
|
||||
## Local development
|
||||
|
||||
> Prerequisites:
|
||||
>
|
||||
> 1. [Forked Medusa repository cloned locally](https://github.com/medusajs/medusa).
|
||||
> 2. [A local Medusa application for testing](https://docs.medusajs.com/learn/installation).
|
||||
|
||||
|
||||
|
||||
The code snippets in this section assume that your forked Medusa project and the test project are sibling directories, and you optionally setup the starter storefront as part of the installation. For example:
|
||||
|
||||
```
|
||||
@@ -42,8 +42,7 @@ The code snippets in this section assume that your forked Medusa project and the
|
||||
|__ test-project_storefront // (optional) storefront to interact with medusa application
|
||||
```
|
||||
|
||||
|
||||
1. Replace the @medusajs/* dependencies and devDependencies in you test project's `package.json` to point to the corresponding local packages in your forked Medusa repository. You will also need to add the medusa packages in the resolutions section of the `package.json`, so that every dependency is resolved locally. For example, assuming your forked Medusa project and the test project are sibling directories:
|
||||
1. Replace the @medusajs/\* dependencies and devDependencies in you test project's `package.json` to point to the corresponding local packages in your forked Medusa repository. You will also need to add the medusa packages in the resolutions section of the `package.json`, so that every dependency is resolved locally. For example, assuming your forked Medusa project and the test project are sibling directories:
|
||||
|
||||
```json
|
||||
// test project package.json
|
||||
@@ -108,6 +107,7 @@ The code snippets in this section assume that your forked Medusa project and the
|
||||
"@medusajs/cli": "file:../medusa/packages/cli/medusa-cli",
|
||||
"@medusajs/modules-sdk": "file:../medusa/packages/core/modules-sdk",
|
||||
"@medusajs/workflows-sdk": "file:../medusa/packages/core/workflows-sdk",
|
||||
"@medusajs/js-sdk": "file:../../medusa/packages/core/js-sdk",
|
||||
"@medusajs/framework": "file:../medusa/packages/core/framework",
|
||||
"@medusajs/auth-emailpass": "file:../medusa/packages/modules/providers/auth-emailpass",
|
||||
"@medusajs/locking-redis": "file:../medusa/packages/modules/providers/locking-redis",
|
||||
@@ -138,6 +138,7 @@ rm -R node_modules && yarn && yarn dev
|
||||
### Branches
|
||||
|
||||
There are currently two base branches:
|
||||
|
||||
- `develop` - development of Medusa 2.0
|
||||
- `v1.x` - development of Medusa v1.x
|
||||
|
||||
@@ -157,7 +158,7 @@ Strive towards keeping your commits small and isolated - this helps the reviewer
|
||||
|
||||
**Base branch**
|
||||
|
||||
If you wish to patch v1.x your base branch should be `v1.x`.
|
||||
If you wish to patch v1.x your base branch should be `v1.x`.
|
||||
|
||||
If your changes should result in a new version of Medusa, you will need to generate a **changelog**. Follow [this guide](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) on how to generate a changeset.
|
||||
|
||||
@@ -192,5 +193,6 @@ All PRs should include tests for the changes that are included. We have two type
|
||||
### Release
|
||||
|
||||
The Medusa team will regularly create releases from two release branches:
|
||||
|
||||
- `develop` - preview releases of Medusa 2.0
|
||||
- `v1.x` - official releases of Medusa 1.x
|
||||
|
||||
Reference in New Issue
Block a user