Skip to content

Commit ee97e74

Browse files
committed
docs: update documentation for jquery-form
Note that jquery-form doesn't get a dedicated issue template because we're unlikely to need to ever touch it again (or at least, touch it often).
1 parent bbcd253 commit ee97e74

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ These apply to any work at Liferay, including in this monorepo:
2727
It is helpful to include [an optional scope in your commit messages](guidelines/general/commit_messages.md) so that people can see, at a glance, which commits affect which projects. Valid scopes correspond to project names such as:
2828

2929
- `eslint-config`
30+
- `jquery-form`
3031
- `js-themes-toolkit`
3132
- `js-toolkit`
3233
- `npm-tools`

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,11 @@ These are the documents that used to live in the [liferay-frontend-guidelines](h
6868
| [`@liferay/js-publish`](./projects/npm-tools/packages/js-publish) | [label: `js-publish`](https://github.com/liferay/liferay-frontend-projects/issues?q=is%3Aissue+is%3Aopen+label%3Ajs-publish) | [New issue](https://github.com/liferay/liferay-frontend-projects/issues/new?labels=npm-tools%2C+js-publish&template=js-publish.md) |
6969
| [`@liferay/npm-bundler-preset-liferay-dev`](./projects/npm-tools/packages/npm-bundler-preset-liferay-dev) | [label: `npm-bundler-preset-liferay-dev`](https://github.com/liferay/liferay-frontend-projects/issues?q=is%3Aissue+is%3Aopen+label%3Anpm-bundler-preset-liferay-dev) | [New issue](https://github.com/liferay/liferay-frontend-projects/issues/new?labels=npm-tools%2C+npm-bundler-preset-liferay-dev&template=npm-bundler-preset-liferay-dev.md) |
7070
| [`@liferay/npm-scripts`](./projects/npm-tools/packages/npm-scripts) | [label: `npm-scripts`](https://github.com/liferay/liferay-frontend-projects/issues?q=is%3Aissue+is%3Aopen+label%3Anpm-scripts) | [New issue](https://github.com/liferay/liferay-frontend-projects/issues/new?labels=npm-tools%2C+npm-scripts&template=npm-scripts.md) |
71+
72+
## Third-party
73+
74+
In addition to our own projects listed above, we sometimes have the need to apply small patches on top of third-party code. Examples can be found in [the `third-party/projects/` directory](./third-party/projects).
75+
76+
| Package | Issues & PRs | Actions |
77+
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
78+
| [`@liferay/jquery-form`](./third-party/projects/jquery-form) | [label: `jquery-form`](https://github.com/liferay/liferay-frontend-projects/issues?q=is%3Aissue+is%3Aopen+label%3Ajquery-form) | [New issue](https://github.com/liferay/liferay-frontend-projects/issues/new?labels=jquery-form) |

third-party/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Projects
2+
3+
## jquery-form
4+
5+
- Upstream project: https://github.com/jquery-form/form
6+
- Base version used by Liferay: [jquery-form/v3.51](https://github.com/liferay/liferay-frontend-projects/tree/jquery-form/v3.51)
7+
- Our package name: `@liferay/jquery-form`
8+
- Usage site in Liferay DXP: [`frontend-js-jquery-web`](https://github.com/liferay/liferay-portal/blob/master/modules/apps/frontend-js/frontend-js-jquery-web)

0 commit comments

Comments
 (0)