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
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -211,7 +211,7 @@ If your pull request introduces a change that may affect the storage or retrieva
211
211
-`it_only_db('mongo')` // will make a test that only runs on mongo
212
212
-`it_exclude_dbs(['postgres'])` // will make a test that runs against all DB's but postgres
213
213
* Similarly, if your feature is intended to only work with PostgreSQL, you should disable MongoDB-specific tests with:
214
-
214
+
215
215
-`describe_only_db('postgres')` // will create a `describe` that runs only on postgres
216
216
-`it_only_db('postgres')` // will make a test that only runs on postgres
217
217
-`it_exclude_dbs(['mongo'])` // will make a test that runs against all DB's but mongo
@@ -299,15 +299,15 @@ Adding a new security check for your feature is easy and fast:
299
299
title:'Door locked',
300
300
warning:'Anyone can enter your house.',
301
301
solution:'Lock the door.',
302
-
check: () => {
302
+
check: () => {
303
303
return; // Example of a passing check
304
304
}
305
305
}),
306
306
newCheck({
307
307
title:'Camera online',
308
308
warning:'Security camera is offline.',
309
309
solution:'Check the camera.',
310
-
check:async () => {
310
+
check:async () => {
311
311
throw1; // Example of a failing check
312
312
}
313
313
}),
@@ -360,7 +360,7 @@ Introducing new [Parse Server configuration][config] parameters requires the fol
360
360
2. If the newparameter does not have one single value but is a parameter group (an object containing multiple sub-parameters):
361
361
- add the environment variable prefix for the parameter group to `nestedOptionEnvPrefix`in [/resources/buildConfigDefinition.js](https://github.com/parse-community/parse-server/blob/master/resources/buildConfigDefinition.js)
362
362
- add the parameter group type to `nestedOptionTypes`in [/resources/buildConfigDefinition.js](https://github.com/parse-community/parse-server/blob/master/resources/buildConfigDefinition.js)
363
-
363
+
364
364
For example, take a look at the existing Parse Server `security`parameter. It is a parameter group, because it has multiple sub-parameter such as `checkGroups`. Itsinterface is defined in [index.js][config-index] as `export interface SecurityOptions`. Therefore, the value to add to `nestedOptionTypes` would be `SecurityOptions`, the value to add to `nestedOptionEnvPrefix` would be `PARSE_SERVER_SECURITY_`.
365
365
366
366
3. Execute `npm run definitions` to automatically create the definitions in [/src/Options/Definitions.js][config-def] and [/src/Options/docs.js][config-docs].
@@ -421,7 +421,7 @@ If the pull request contains a breaking change, the commit message must contain
421
421
422
422
```
423
423
fix: remove handle from door
424
-
424
+
425
425
BREAKING CHANGE: You cannot open the door anymore by using a handle. See the [#migration guide](http://example.com) for more details.
426
426
```
427
427
Keep in mind that in a repository with release automation, merging such a commit message will trigger a release with a major version increment.
@@ -432,7 +432,7 @@ If the commit reverts a previous commit, use the prefix `revert:`, followed by t
432
432
433
433
```
434
434
revert: fix: remove handle from door
435
-
435
+
436
436
This reverts commit 1234567890abcdef.
437
437
```
438
438
@@ -448,7 +448,7 @@ If the commit reverts a previous commit, use the prefix `revert:`, followed by t
448
448
instead of:
449
449
```
450
450
revert: ci: add something
451
-
451
+
452
452
This reverts commit 1234567890abcdef.
453
453
```
454
454
@@ -525,7 +525,7 @@ The following changes are done in the `alpha` branch, before publishing the last
525
525
7. Merge PR with "squash and merge", do not do a "merge commit":
526
526
- Commit message: (use PR title)
527
527
- Description: (leave empty)
528
-
528
+
529
529
ℹ️ Merging this PR will not trigger a release; the back-merge will not appear in changelogs of the `beta`, `alpha` branches; the back-merged fix will be an undocumented change of these branches' next releases; if necessary, the change needs to be added manually to the pre-release changelogs *after* the next pre-releases.
530
530
8. Delete temporary branch `backmerge`.
531
531
10. Create a new temporary branch `backmerge` on branch `beta`.
0 commit comments