Skip to content

Commit 08e359b

Browse files
authored
add requirement: if FL submitted, display-name == internal UDL name
1 parent 9401c0a commit 08e359b

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,15 @@ To be accepted, your submission _must_ meet the following **requirement**s and _
2020
* A possible exception might be if you are bundling multiple UDL for related languages all using the same theme. Example: `3dModeling_bundle_forChocoTheme_includes_STL_OBJ_3DS.udl.xml` would implement highlighting rules for the three 3D modeling formats of STL, OBJ, and 3DS, all for the same Choco theme.
2121
4. **requirement**: each `display-name` attribute in the JSON file (described below) must be unique.
2222
5. **recommendation**: if your UDL file only contains one language, the `display-name` attribute in the JSON file (described below) should have the same value as the `<UserLang name="...">` inside your definition file. This will keep the name in the **Language** menu the same as the name that was shown in the download tool (once it is developed and released).
23-
6. **recommendation**: in your Pull Request, please provide a link to a public description of the language your UDL is based on (which will help to establish the general-interest nature of the UDL), as well as a link to an example file in that language (so that the UDL can be verified as functional).
23+
* **recommendation**: if your UDL file containts multiple languages, consider splitting them into separate files, so that the `display-name` attribute can match the UDL's `<UserLang name="...">`
24+
*
25+
7. **recommendation**: in your Pull Request, please provide a link to a public description of the language your UDL is based on (which will help to establish the general-interest nature of the UDL), as well as a link to an example file in that language (so that the UDL can be verified as functional).
2426
* If you have an example file, you can upload it to the `UDL-samples` folder of the repository. Please have this file use the same name as your UDL definition file, but with the appropriate file extension, rather than `.xml`. Example: `UDLs\STL_udl.byPryrt.xml` would have a corresponding example file `UDL-samples\STL_udl.byPryrt.stl`.
2527
* **requirement**: if you have included a functionList definition, it must also include a sample file.
26-
7. **recommendation**: if you have also created an [autoCompletion file](https://npp-user-manual.org/docs/auto-completion/) for your UDL, you may add it in the `autoCompletion` folder before you submit your PR.
27-
- **requirement**: if you have a autoCompletion definition, the name of the definition file must match the name of the UDL (per [User Manual > Auto-completion File Format](https://npp-user-manual.org/docs/auto-completion/#auto-completion-file-format)).
28-
8. **recommendation**: if you have also created a [functionList definition](https://npp-user-manual.org/docs/function-list/) for your UDL, you may add it in the `functionList` folder before you submit your PR.
28+
8. **recommendation**: if you have also created an [autoCompletion file](https://npp-user-manual.org/docs/auto-completion/) for your UDL, you may add it in the `autoCompletion` folder before you submit your PR.
29+
- **requirement**: if you have an autoCompletion definition, the name of the definition file must match the name of the UDL (`<UserLang name="...">`), per [User Manual > Auto-completion File Format](https://npp-user-manual.org/docs/auto-completion/#auto-completion-file-format)).
30+
9. **recommendation**: if you have also created a [functionList definition](https://npp-user-manual.org/docs/function-list/) for your UDL, you may add it in the `functionList` folder before you submit your PR.
31+
- **requirement**: if you have a functionList definition, the `display-name` **must** match the name of the UDL (from `<UserLang name="...">`).
2932

3033
## Edit `udl-list.json`
3134

0 commit comments

Comments
 (0)