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: maintenance/projects/js-toolkit/CONTRIBUTING.md
+5-15Lines changed: 5 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,9 +12,9 @@ $ yarn ⏎
12
12
13
13
Which will install all needed dependencies.
14
14
15
-
## Repo organization
15
+
## Project organization
16
16
17
-
The repo is a yarn workspace with several projects contained in the `packages` folder.
17
+
The project is a Yarn workspace with several projects contained in the `packages` folder.
18
18
19
19
Other auxiliary folders are:
20
20
@@ -36,15 +36,7 @@ This runs locally the same tests we run in our CI servers so that, in case anyth
36
36
37
37
We track all discussions and decisions in GitHub issues and PRs. We also try to explain final decisions in git commits so that they are easily available without any need to visit GitHub.
38
38
39
-
To maintain cross referenceability all commits must follow the [semantic commit convention](http://karma-runner.github.io/0.10/dev/git-commit-msg.html) and use `#nnn` as the first word in the subject (where `nnn` is the number of the issue associated to the commit).
40
-
41
-
For example:
42
-
43
-
```
44
-
chore: #517 Fix yarn dependencies
45
-
```
46
-
47
-
No commit may be pushed without a reference to an issue unless it is self-evident and of type `chore`.
39
+
All commits must follow [our commit message guidelines](https://github.com/liferay/liferay-frontend-guidelines/blob/master/general/commit_messages.md).
48
40
49
41
## Tests
50
42
@@ -76,7 +68,7 @@ By default, the resulting JAR file will be placed in `/opt/bundles/deploy` so ma
76
68
77
69
This command will download all the dependencies needed by the QA projects contained in the `qa/samples/packages` folder, and will point all JS Toolkit packages to the local project (as opposed to downloading them from npmjs.com). This is necessary since we want to use our local copy of the JS Toolkit and since we have not yet released any 3.x version, so it's impossible to download it from npmjs.com.
78
70
79
-
Note that the `link-js-toolkit` will move all JS Toolkit dependencies in the QA projects to a `link-js-toolkit` section in the `package.json`. This is to prevent yarn from trying to download these packages from npmjs.com.
71
+
Note that the `link-js-toolkit` will move all JS Toolkit dependencies in the QA projects to a `link-js-toolkit` section in the `package.json`. This is to prevent Yarn from trying to download these packages from npmjs.com.
80
72
81
73
## Releasing new versions
82
74
@@ -123,12 +115,10 @@ Release a new version
123
115
$ yarn release ⏎
124
116
```
125
117
126
-
Copy the relevant section from the changelog to the corresponding entry on the [releases page](https://github.com/liferay/liferay-js-toolkit/releases).
118
+
Copy the relevant section from the changelog to the corresponding entry on the [releases page](https://github.com/liferay/liferay-frontend-projects/releases).
127
119
128
120
After the release, you may want to confirm that the packages are correctly listed in the NPM registry.
129
121
130
-
Finally, close [the corresponding milestone](https://github.com/liferay/liferay-js-toolkit/milestones) in GitHub.
131
-
132
122
## Releasing canary versions
133
123
134
124
Lerna offers the possibility to release canary versions, which are pre-releases published to npmjs.com but only accessible on demand (i.e., they are not automatically downloaded when dependencies are updated),
You can file any bug related to this project in the [issues page](https://github.com/liferay/liferay-frontend-projects/issues?q=is%3Aissue+is%3Aopen+label%3Ajs-toolkit+label%3A2.x).
33
30
34
-
You can also get information about released versions and their changes in the
0 commit comments