CONTRIBUTING.md 1.69 KB
Newer Older
1
Glade official git repository is hosted by the GNOME foundation at
Juan Pablo Ugarte's avatar
Juan Pablo Ugarte committed
2
gitlab.gnome.org
3
4
5

Mailing List
~~~~~~~~~~~~
Juan Pablo Ugarte's avatar
Juan Pablo Ugarte committed
6
Glade discussion takes place on glade-devel-list@gnome.org
7
8

To subscribe or to consult archives visit
Juan Pablo Ugarte's avatar
Juan Pablo Ugarte committed
9
	https://mail.gnome.org/mailman/listinfo/glade-devel-list
10
11


12
GitLab
13
14
15
~~~~~~~~
Glade bugs are tracked at

16
	https://gitlab.gnome.org/GNOME/glade
17
18
19
20


GIT
~~~
21
You can browse the source code at https://gitlab.gnome.org/GNOME/glade
22
23
To check out a copy of Glade you can use the following command:

24
	git clone https://gitlab.gnome.org/GNOME/glade.git
25
26
27
28
29
30
31
32
33
34
35
36

Patches
~~~~~~~
Patches must be in the unified format (diff -u) and must include a
ChangeLog entry. Please send all patches to bugzilla.

It is better to use git format-patch command

git format-patch HEAD^

Coding Style
~~~~~~~~~~~~
37
38
39
Code in Glade should follow the GNU style of GNOME Programming Guidelines
(https://developer.gnome.org/programming-guidelines/stable/c-coding-style.html.en),
basically this means being consistent with the surrounding code.
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
The only exception is that we prefer having braces always on a new line
e.g.:

if (...)
  {
    ...
  }

Note however that a lot of the current codebase still uses the following
style:

if (...) {
  ...
}

Over time we'll migrate to the preferred form.

Naming conventions:
- function names should be lowercase and prefixed with the
  file name (or, if the function is static and the name too long,
  with an abbreviation), e.g:
Juan Pablo Ugarte's avatar
Juan Pablo Ugarte committed
61
  glade_project_window_my_function ()
62
63
64
65
66
67
68
69
70
  gpw_my_loooooooooong_named_fuction ()
- variable names should be lowercase and be short but self explanatory;
  if you need more than one word use an underscore, e.g:
  my_variable

Also try to order your functions so that prototypes are not needed.