Skip to content

Commit 3df392a

Browse files
committed
docs: update contribution guide
1 parent 4dc4ba8 commit 3df392a

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

.github/CONTRIBUTING.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -176,41 +176,38 @@ This repository employs a [monorepo](https://en.wikipedia.org/wiki/Monorepo) set
176176

177177
```mermaid
178178
flowchart TD
179-
shared["@intlify/shared"]
180-
message-compiler["@intlify/message-compiler"]
181-
core-base["@intlify/core-base"]
182-
core["@intlify/core"]
183-
vue-i18n-core["@intlify/vue-i18n-core"]
184-
petite-vue-i18n["petite-vue-i18n"]
185-
vue-i18n["vue-i18n"]
179+
message-compiler
180+
core-base
181+
core
182+
vue-i18n-core
183+
petite-vue-i18n
184+
vue-i18n
186185
187186
subgraph Framework Agnostice Packages
188-
message-compiler --> shared
189-
core-base --> shared
190187
core-base --> message-compiler
191-
core --> shared
192188
core --> core-base
193189
end
194190
195191
subgraph Vue Layer Packages
196-
vue-i18n-core --> shared
197192
vue-i18n-core --> core-base
198-
vue-i18n --> shared
199193
vue-i18n --> core-base
200194
vue-i18n --> vue-i18n-core
201-
petite-vue-i18n --> shared
202195
petite-vue-i18n --> core-base
203196
petite-vue-i18n --> vue-i18n-core
204197
end
205198
```
206199

207-
- `shared`: Internal utilities shared across multiple packages.
208200
- `message-compiler`: The intlify message format compiler.
209-
- `core-base`: The inlitfy core base.
201+
- `core-base`: The inlitfy core logic implementation.
210202
- `core`: The intlify core "full build" which includes both the runtime AND the compiler.
211-
- `vue-i18n-core`: The vue-i18n core implementation package.
212-
- `vue-i18n`: The vue-i18n "full build" which includes both the runtime AND the compiler.
203+
- `vue-i18n-core`: The vue-i18n core implementation.
213204
- `petite-vue-i18n`: The vue-i18n "small build" which includes both the runtime AND the compiler.
205+
- `vue-i18n`: The vue-i18n "full build" which includes both the runtime AND the compiler.
206+
207+
There are some caveats to these packages:
208+
209+
- The modules `vue-i18n` and `vue-i18n-core`, the core logic of `petite-vue-i18n`, should be imported with relative paths.
210+
- Similarly for `core`, modules of `core-base`, which is the core logic implemented, should be imported with relative paths.
214211

215212
### Importing Packages
216213

@@ -223,7 +220,6 @@ import { baseCompile } from '@intlify/compiler'
223220
This is made possible via several configurations:
224221

225222
- For TypeScript, `compilerOptions.path` in `tsconfig.json`
226-
- For Jest, `moduleNameMapper` in `jest.config.js`
227223
- For plain Node.js, they are linked using [PNPM Workspaces](https://pnpm.io/workspaces).
228224

229225
## Contributing Tests

0 commit comments

Comments
 (0)