summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: f43f33df97f683b94d1f1a81f80e92c927c40dd4 (plain)
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
Glade official git repository is hosted by the GNOME foundation at
git.gnome.org

The GNOME contributing guidelines recomend patches to be forwarded
to GNOME's Bugzilla instance hosted at https://bugzilla.gnome.org,
as such please do not open Pull Requests (PRs) in others git mirrors
since there is a good chance they will not get noticed.

Mailing List
~~~~~~~~~~~~
Glade discussion takes place on glade-devel@lists.ximian.com

To subscribe or to consult archives visit
	http://lists.ximian.com/mailman/listinfo/glade-devel


Bugzilla
~~~~~~~~
Glade bugs are tracked at

	http://bugzilla.gnome.org/enter_bug.cgi?product=glade


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

	git clone git://git.gnome.org/glade

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
~~~~~~~~~~~~
Code in Glade should follow the GNOME Programming Guidelines
(http://developer.gnome.org/doc/guides/programming-guidelines/),
basically this means being consistent with the sorrounding code.
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:
  glade_project_window_my_function () 
  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.