Skip to content

Commit 9608f52

Browse files
committed
Update CONTRIBUTING to give instructions on how to locally validate
1 parent e4ab37e commit 9608f52

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ The goal of this Collection is to provide a UDL center for users who need the pr
22

33
You may also optionally submit an Auto-Completion definition and/or a Function List definition to go with your UDL (or to go with someone else's UDL).
44

5-
To submit a UDL and/or autoCompletion definition and/or functionList definition, you have to modify [udl-list.json](https://github.com/notepad-plus-plus/userDefinedLanguages/blob/master/udl-list.json), then submit a Pull Request to add it to the Collection. The team will review your submission, and either merge it into the Collection, ask for clarification or fixes, or reject the submission.
5+
To submit a UDL and/or autoCompletion definition and/or functionList definition, you have to modify [udl-list.json](https://github.com/notepad-plus-plus/userDefinedLanguages/blob/master/udl-list.json), then submit a Pull Request to add it to the Collection. The team will review your submission, and either merge it into the Collection, ask for clarification or fixes, or reject the submission.
66

77
**Do _not_ edit [udl-list.md](https://github.com/notepad-plus-plus/userDefinedLanguages/blob/master/udl-list.md): that file is auto-generated from the JSON to save effort and maintain consistency.**
88

@@ -36,7 +36,7 @@ To be accepted, your submission _must_ meet the following **requirement**s and _
3636
- **requirement**: if you are supplying a function list definition XML file, it must go in the `functionList` directory
3737
- **requirement**: if you are supplying a sample file, it must go in the `UDL-samples` directory
3838
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.
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.
4040
- Do not just submit the PR then never come back to check the status.
4141
- 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.
4242

@@ -121,3 +121,17 @@ There will be automatic validation and verification of some of these requirement
121121
If you do not resolve the errors (or other fixes requested by the maintenance team) or at least ask for help, the maintenance team is allowed to close a PR after a week without you resolving the errors (or a week of you not replying to their most recent comment, if there has been a conversation regarding the errors).
122122

123123
The maintenance team have the decision power as to whether or not a given PR is accepted or rejected. If it is rejected for reasons other than validation errors or failure, they must explain their reasoning in the PR conversation.
124+
125+
### Validating before submitting PR
126+
127+
If you have python available, it is _highly_ recommended that you validate your updates and make them pass _before_ submitting the PR, by running the following:
128+
129+
```
130+
python -m pip install -r requirements.txt
131+
python .validators\validator_xml.py
132+
python .validators\validator_json.py
133+
```
134+
135+
Warnings are okay, but if there are any errors, you can fix them _before_ you submit a PR, which will make the PR acceptance go more smoothly.
136+
137+
Thank you.

0 commit comments

Comments
 (0)