File: HACKING.md

package info (click to toggle)
phosh 0.53.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,936 kB
  • sloc: ansic: 83,383; xml: 3,981; python: 717; sh: 449; makefile: 34; lisp: 22; javascript: 6
file content (33 lines) | stat: -rw-r--r-- 652 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
Building
========
For build instructions see the README.md

Pull requests
=============
Before filing a pull request run the tests:

```sh
ninja -C _build test
```

Use descriptive commit messages, see

   https://wiki.gnome.org/Git/CommitMessages

and check

   https://wiki.openstack.org/wiki/GitCommitMessages

for good examples.


Coding Style
============
The code style used here is heavily inspired/copied from [phosh's][1]
and [calls'][2] Coding style.


g_assert() vs g_return_if_fail()
============
`g_assert ()` should only be used in internal checks. For the public API
you should guard against wrong parameters with `g_return_if_fail ()`.