asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore: fix links in contribution guidelines (#11829)

Browse Source
This commit is contained in:
Shahed Nasser
2025-03-24 08:08:16 +02:00
committed by GitHub
parent de8c034d1b
commit 1bcd822963
1 changed files with 2 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -13,7 +13,7 @@ If you, as a community contributor, wish to work on more extensive features, ple
- **You're familiar with GitHub Issues and Pull Requests** - **You're familiar with GitHub Issues and Pull Requests**
- **You've read the [docs](https://docs.medusajs.com).** - **You've read the [docs](https://docs.medusajs.com).**
- **You've setup a test project with `medusa new`** - **You've setup a test project with `npx create-medusa-app@latest`**
## Issues before PRs ## Issues before PRs
@@ -73,13 +73,11 @@ All PRs should include tests for the changes that are included. We have two type
- **Unit tests** found under `packages/*/src/services/__tests__` and `packages/*/src/api/routes/*/__tests__` - **Unit tests** found under `packages/*/src/services/__tests__` and `packages/*/src/api/routes/*/__tests__`
- **Integration tests** found in `integration-tests/*/__tests__` - **Integration tests** found in `integration-tests/*/__tests__`
Check out our [local development documentation](https://docs.medusajs.com/usage/local-development) to learn how to test your changes both in the Medusa repository and in a local server.
### Documentation ### Documentation
- We generally encourage to document your changes through comments in your code. - We generally encourage to document your changes through comments in your code.
- If you alter user-facing behaviour you must provide documentation for such changes. - If you alter user-facing behaviour you must provide documentation for such changes.
- All methods and endpoints should be documented using [JSDoc](https://jsdoc.app/) and [`swagger-inline`](https://www.npmjs.com/package/swagger-inline) - All methods and endpoints should be documented using [TSDoc](https://tsdoc.org/).
### Release ### Release