Debian Codegraph @

HACKING

raw
1 CODING STYLE
2 ============
3
4 - Please follow the coding style already used (which is close to the
5 GNU style) - if adding new files please include the following mode
6 line for emacs and other editors:
7
8 -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
9
10 - Spaces, not tabs, are used.
11
12 - All external interfaces (network protocols, file formats, etc.)
13 should be documented in man pages or other documentation.
14
15
16 SOURCE CONTROL
17 ==============
18
19 Anonymous checkouts:
20
21 $ git clone [email protected]:storaged-project/udisks.git
22
23 MAKING RELEASES
24 ===============
25
26 Checklist for making a release:
27
28 - Update the NEWS file
29
30 - Update the AUTHORS file if we have any new authors since last release. The
31 git command `git shortlog -se` helps.
32
33 - Check that everything works
34 - Run 'make check' and 'make ci'
35 - Check that you have no uncommitted or unpushed changes
36 - Check there are no glaring TODO or FIXME
37 - Sanity-check all new API
38 - Ensure newly added API is marked properly with "Since: X.Y"
39 - Ensure that deprecated API is marked as such
40
41 - Tag the release: git tag udisks-X.Y.Z
42
43 - Post-release actions:
44 - Bump the version in configure.in and packaging/udisks2.spec
45 - Prepare NEWS file - append " (unreleased)" to version number
46 - Commit message: Post-release version bump to X.Y.Z
47
48 - Upload new documentation to storaged.org website
49 - https://github.com/storaged-project/storaged-project.github.io
50 - Create new folder X.Y.Z in "doc/udisks2-api/" and update the "latest" symlink
51 - Add link to the new version to "doc/udisks2-api/index.html"
52
53 When doing the first micro release in a new minor series (for example
54 starting the 2.0.0, 2.1.0, 2.2.0 etc. series), do the following
55
56 - Update the date in man pages to "$MONTH $YEAR" e.g. "October 2012"
57
58 - At some point after the release, create the udisks-X-Y branch
59 - Perform the post-release actions above on the created branch
60 - This is for maintenance releases
61 - Do this when focus is on new feature development
62 - Then bump version on master to X.Y.90 (prereleases for X.Y+1.0)
63 - Add "Index of new symbols in X.Y+1" index to doc/udisks2-docs.xml
64
65 For maintenance releases, the rules are simple
66
67 - Work on the udisks-X-Y branch
68 - If possible, cherry-pick fixes from master ('git cherry-pick')
69 - Do not add (or backport) any new API or features
70 - Do not add, remove or change any translatable strings
71 - Do not add new dependencies
72
73 TRANSLATIONS
74 ============
75
76 - Don't use VPATH build (To be fixed)
77
78 - Some weeks before the planned release announce the upcoming release
79 on the GNOME Discourse in the Applications category with the i18n tag
80 https://discourse.gnome.org/
81
82 - Check that Github -> Damned Lies synchronization works and that new strings
83 show up on the l10n module page: https://l10n.gnome.org/module/udisks/
84
85 - Check that recent commits to the po/ directory done by the GNOME
86 Infrastructure Automation Bot (@gnomesysadmins) reflect the translation
87 status on the l10n page
88
89 COMMITTING CODE
90 ===============
91
92 - Commit messages should be of the form (the five lines between the
93 lines starting with ===)
94
95 === begin example commit ===
96 Short explanation of the commit
97
98 Longer explanation explaining exactly what's changed, whether any
99 external or private interfaces changed, what bugs were fixed (with bug
100 tracker reference if applicable) and so forth. Be concise but not too brief.
101 === end example commit ===
102
103 - Always add a brief description of the commit to the _first_ line of
104 the commit and terminate by two newlines (it will work without the
105 second newline, but that is not nice for the interfaces).
106
107 - First line (the brief description) must only be one sentence and
108 must start with a capital letter. Don't use a trailing period.
109
110 - The main description (the body) is normal prose and should use normal
111 punctuation and capital letters where appropriate. Normally, for patches
112 sent to a mailing list it's copied from there.
113
114 - When committing code on behalf of others use the --author option, e.g.
115 git commit -a --author "Joe Coder <[email protected]>"