Skip to content

Commit ff4d27c

Browse files
authored
Clarify file locations; codify that PR must pass automated checks
1 parent c642c40 commit ff4d27c

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ To be accepted, your submission _must_ meet the following **requirement**s and _
3030
- **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)).
3131
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.
3232
- **requirement**: if you have a functionList definition, the `display-name` **must** match the name of the UDL (from `<UserLang name="...">`).
33+
10. **requirement**: each file must go in the right directory in the repository:
34+
- **requirement**: the main UDL definition XML file goes in the `UDLs` directory
35+
- **requirement**: if you are supplying an auto-completion definition XML file, it must go in the `autoCompletion` directory
36+
- **requirement**: if you are supplying a function list definition XML file, it must go in the `autoCompletion` directory
37+
- **requirement**: if you are supplying a sample file, it must go in the `UDL-samples` directory
38+
11. **requirement**: submissions to the UDL Collection must pass all automated tests.
39+
- If the PR action does not pass, you will be required to fix the problem in a timely fashion, or the PR can and will be rejected.
40+
- Do not just submit the PR then never come back to check the status.
41+
- Look for notifications (emails or website notifications) from GitHub: it might be informing you of a failure, or letting you know that one of the maintenance team has replied to your PR.
3342

3443
## Edit `udl-list.json`
3544

0 commit comments

Comments
 (0)