Skip to content

Commit 330e6b9

Browse files
authored
Enforce alphabetical order for supported file types list (#531)
Signed-off-by: Richie Bendall <[email protected]>
1 parent 093eafe commit 330e6b9

File tree

4 files changed

+149
-118
lines changed

4 files changed

+149
-118
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ If you're adding support for a new file type, please follow the below steps:
1111
- Existing signatures requiring same sample length (same *signature group*) will be tested prior to your new detections. Yours will be last. (rational: common formats first).
1212
- Add the file extension to the `FileType` type in `core.d.ts`.
1313
- Add the file's MIME type to the `MimeType` type in `core.d.ts`.
14-
- Add the file extension to the `Supported file types` section in the readme, in the format ```- [`<extension>`](URL) - Format name```, for example, ```- [`png`](https://en.wikipedia.org/wiki/Portable_Network_Graphics) - Portable Network Graphics```
14+
- Add the file extension to the `Supported file types` section of the readme in alphabetical order, in the format ```- [`<extension>`](URL) - Format name```, for example, ```- [`png`](https://en.wikipedia.org/wiki/Portable_Network_Graphics) - Portable Network Graphics```
1515
- Add the file extension to the `keywords` array in the `package.json` file.
1616
- Run `$ npm test` to ensure the tests pass.
1717
- Open a pull request with a title like `Add support for Format`, for example, `Add support for PNG`.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@
204204
"@tokenizer/token": "^0.3.0",
205205
"@types/node": "^16.11.10",
206206
"ava": "^3.15.0",
207+
"commonmark": "^0.30.0",
207208
"noop-stream": "^1.0.0",
208209
"tsd": "^0.19.0",
209210
"typescript": "^4.5.2",

0 commit comments

Comments
 (0)