Skip to content

Commit cb94002

Browse files
committed
docs: reorganize contributing
1 parent 9607ba5 commit cb94002

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,25 @@ If unknown, every property could be `undefined`.
5959

6060
## Contributing
6161

62+
The primary way to contribute to this database is by updating the data in
63+
one of the upstream sources. The database is updated from the upstreams
64+
periodically and will pull in any changes.
65+
66+
### Registering Media Types
67+
68+
The best way to get new media types included in this library is to register
69+
them with the IANA. The community registration procedure is outlined in
70+
[RFC 6838 section 5](http://tools.ietf.org/html/rfc6838#section-5). Types
71+
registered with the IANA are automatically pulled into this library.
72+
73+
### Direct Inclusion
74+
75+
If that is not possible / feasible, they can be added directly here as a
76+
"custom" type. To do this, it is required to have a primary source that
77+
definitively lists the media type. If an extension is going to be listed as
78+
associateed with this media type, the source must definitively link the
79+
media type and extension as well.
80+
6281
To edit the database, only make PRs against `src/custom-types.json` or
6382
`src/custom-suffix.json`.
6483

@@ -76,19 +95,6 @@ keys and the values being an object with the following keys:
7695

7796
To update the build, run `npm run build`.
7897

79-
### Adding Custom Media Types
80-
81-
The best way to get new media types included in this library is to register
82-
them with the IANA. The community registration procedure is outlined in
83-
[RFC 6838 section 5](http://tools.ietf.org/html/rfc6838#section-5). Types
84-
registered with the IANA are automatically pulled into this library.
85-
86-
If that is not possible / feasible, they can be added directly here as a
87-
"custom" type. To do this, it is required to have a primary source that
88-
definitively lists the media type. If an extension is going to be listed as
89-
associateed with this media type, the source must definitively link the
90-
media type and extension as well.
91-
9298
[ci-image]: https://badgen.net/github/checks/jshttp/mime-db/master?label=ci
9399
[ci-url]: https://github.com/jshttp/mime-db/actions/workflows/ci.yml
94100
[coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/mime-db/master

0 commit comments

Comments
 (0)