Bug 661241 - Add a new code style/hacking guide
Add a new code style/hacking guide
Status: RESOLVED FIXED
Product: gnome-shell
Classification: Core
Component: general
unspecified
Other All
: Normal normal
: ---
Assigned To: gnome-shell-maint
gnome-shell-maint
:
Depends on:
Blocks:
  Show dependency tree
 
Reported: 2011-10-07 23:48 UTC by Jasper St. Pierre (not reading bugmail)
Modified: 2012-10-10 22:14 UTC (History)
2 users (show)

See Also:
GNOME target: ---
GNOME version: ---

Attachments
Add a new code style/hacking guide (10.58 KB, patch)
2011-10-07 23:48 UTC, Jasper St. Pierre (not reading bugmail) 		none Details | Diff | Review
Add a new code style/hacking guide (10.69 KB, patch)
2011-10-20 20:38 UTC, Jasper St. Pierre (not reading bugmail) 		none Details | Diff | Review
Add a new code style/hacking guide (10.65 KB, patch)
2011-10-24 16:46 UTC, Jasper St. Pierre (not reading bugmail) 		none Details | Diff | Review
Add a new code style/hacking guide (11.28 KB, patch)
2012-02-14 22:44 UTC, Jasper St. Pierre (not reading bugmail) 		committed Details | Diff | Review
Show Obsolete (3) View All Add an attachment (proposed patch, testcase, etc.)

Description Jasper St. Pierre (not reading bugmail) 2011-10-07 23:48:09 UTC 
A style/hacking guide, written in Markdown style, based off of the gjs guide and some of the comments at
https://live.gnome.org/GnomeShell/StyleGuide
Comment 1 Jasper St. Pierre (not reading bugmail) 2011-10-07 23:48:10 UTC 
Created attachment 198581 [details] [review]
Add a new code style/hacking guide

Written in Markdown style.

Somewhat based off of the gjs code style guide found at
http://git.gnome.org/browse/gjs/plain/doc/Style_Guide.txt.
Comment 2 Dan Winship 2011-10-12 20:25:08 UTC 
see also bug 612605
Comment 3 Jasper St. Pierre (not reading bugmail) 2011-10-20 20:38:02 UTC 
Created attachment 199585 [details] [review]
Add a new code style/hacking guide

Written in Markdown style.

Somewhat based off of the gjs code style guide found at
http://git.gnome.org/browse/gjs/plain/doc/Style_Guide.txt.



--

fill-region broke my indented code style at the beginning
Comment 4 Jasper St. Pierre (not reading bugmail) 2011-10-24 16:46:02 UTC 
Created attachment 199847 [details] [review]
Add a new code style/hacking guide

Written in Markdown style.

Somewhat based off of the gjs code style guide found at
http://git.gnome.org/browse/gjs/plain/doc/Style_Guide.txt.



--

Fix some whitespace errors.
Comment 5 Jasper St. Pierre (not reading bugmail) 2012-02-14 22:44:13 UTC 
Created attachment 207596 [details] [review]
Add a new code style/hacking guide

Written in Markdown style.

Somewhat based off of the gjs code style guide found at
http://git.gnome.org/browse/gjs/plain/doc/Style_Guide.txt.



--

Updated with information about gobject inheritance and the Lang.Class framework.
Comment 6 Jasper St. Pierre (not reading bugmail) 2012-10-10 22:14:10 UTC 
Attachment 207596 [details] pushed as 1e942be - Add a new code style/hacking guide


I figured it would be better to push this now than never. At the summit, Marina suggested it would be a good thing to have for contributors. I hastily updated it for a few new guidelines, so if it's wrong, feel free to push to this one without review. Also, feel free to contribute to it without review as well.
Note You need to log in before you can comment on or make changes to this bug.