HACKING 2.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
A few ground rules for people interested in adding new mime-types.

* Mime-types used should be IANA registered mime-types when possible
* When old mime-types become registered, the new definition should
  include an alias for the old mime-type
* New entries or modifications should include a test case (see below)
* Mime-types/file formats proprietary to one application should only
  be added to a private .xml file and be bundled with the application
  itself
10
11
* No commits should be done that break the test suite, or the test suite
  test in question should be amended, and reason for the changes clearly
12
  documented in the commit message
13

14
15
16
Translations
------------

17
Translations should go through Transifex.net, and the freedesktop.org team:
Bastien Nocera's avatar
Bastien Nocera committed
18
http://www.transifex.net/projects/p/shared-mime-info/
19

20
git
21
22
23
---

Check it out using:
24
25
26
27
28
29
git clone git://anongit.freedesktop.org/xdg/shared-mime-info
or if you have a freedesktop account:
git clone ssh://git.freedesktop.org/git/xdg/shared-mime-info

Web interface is at:
http://cgit.freedesktop.org/xdg/shared-mime-info/
30

31
32
33
34
35
36
37
Filing bugs
-----------

Bugs can be filed at:
https://bugs.freedesktop.org/enter_bug.cgi?product=shared-mime-info

Bugs for new mime-types should include:
38
- a patch generated against the current git master, with authorship information
39
40
- one or more test files to be added to the test suite

41
42
43
Test suite
----------

44
You need to have xdgmime checked out [1] and compile at the same level as
45
46
47
48
49
50
51
52
53
shared-mime-info. ../xdgmime/src/test-mime-data will be run against
tests/list.

The format of the file is:
<testcase filename> <expected mime-type> <expected failures>

The expected failures is whether matching the file with the mime-type would
fail when matched by file, data or name. "x" indicates expected failure, "o"
indicates expected success. Trailing "o"s can be omitted.
54

55
56
57
58
59
See the top of the tests/list file for syntax details.

[1]: Repository details at:
http://cgit.freedesktop.org/xdg/xdgmime/

60
61
62
Releasing
---------

63
- Run "make update-translations" and "make check-translations" before release
64
65
- Copy the file to ~hadess/public_html on gabe.freedesktop.org
- Update http://www.freedesktop.org/wiki/Software/shared-mime-info
66

67
68
69
70
71
72
73
Updating the spec on the website
--------------------------------

- On gabe, go in /srv/specifications.freedesktop.org/www
- Edit specs.idx
- Run ../update.py