You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+42-40
Original file line number
Diff line number
Diff line change
@@ -12,32 +12,32 @@ This project and everyone participating in it are governed by the [Code of Condu
12
12
13
13
The documentation is based on [Docusaurus](https://docusaurus.io/) framework. Source inside the [website](https://github.com/lingui/js-lingui/tree/main/website) directory.
14
14
15
-
- Go to the `website` directory:
15
+
- Go to the `website` directory:
16
16
17
17
```sh
18
18
cd website
19
19
```
20
20
21
21
- Install dependencies:
22
22
23
-
```sh
24
-
yarn install
25
-
```
23
+
```sh
24
+
yarn install
25
+
```
26
26
27
27
- To build the docs, watch for changes and preview documentation locally at [http://localhost:3000/](http://localhost:3000/):
28
28
29
-
```sh
30
-
yarn start
31
-
```
29
+
```sh
30
+
yarn start
31
+
```
32
32
33
33
- It's also possible to run `yarn build` for single build. Incremental builds are much faster than the first one as only changed files are built.
34
34
35
35
- Please lint and validate the documentation before submitting any changes:
> If you are using an IDE to run test make sure to use the right Jest config.
73
-
> For unit tests use `-c jest.config.js`. Integration tests use build packages (created using `yarn release:build`) and config `-c jest.config.integration.js`. See [package.json](./package.json) for more info.
74
-
75
71
### Using development version in your project
76
72
77
73
After you successfully fix a bug or add a new feature, you most probably want to test it in a real-world project as soon as possible.
@@ -84,44 +80,50 @@ There are two documented ways to do this: first is a generic way described in th
84
80
85
81
1. Run `verdaccio` locally in docker (follow [verdaccio guide](https://verdaccio.org/docs/en/what-is-verdaccio.html) if you don't want to run it in Docker):
86
82
87
-
```sh
88
-
docker run -d -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio
89
-
```
83
+
```sh
84
+
docker run -d -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio
85
+
```
90
86
91
-
> Make sure that your verdaccio user is the same that appears in verdacio-release.js script.
87
+
> Make sure that your verdaccio user is the same that appears in verdacio-release.js script.
92
88
93
89
2. Publish local build of packages to registry. Run local release script:
94
90
95
-
```sh
96
-
yarn verdaccio:release
97
-
```
91
+
```sh
92
+
yarn verdaccio:release
93
+
```
98
94
99
95
3. If you enter inside http://0.0.0.0:4873 (verdaccio instance), you will see your packages published, so you're ready to install them.
100
96
101
97
4. Inside your project, run:
102
98
103
-
with NPM:
104
-
```sh
105
-
# Point to your local registry
106
-
npm config set registry http://0.0.0.0:4873/
107
-
# Run update-by-scope will update all @lingui packages
0 commit comments