[gnome-devel-docs] programming-guidelines: Rework introduction to cover the GNOME ecosystem



commit 73e423258467ea7f0ff26d93bffa355b0b14ccfe
Author: Philip Withnall <philip withnall collabora co uk>
Date:   Tue Feb 3 10:01:56 2015 +0000

    programming-guidelines: Rework introduction to cover the GNOME ecosystem
    
    These guidelines are useful enough to cover development of any
    application which uses GNOME technologies — not just development of core
    GNOME applications. Rework the introduction to fit that a little better.
    
    Also cheekily add myself as an author in anticipation of further
    commits.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=376123

 programming-guidelines/C/index.page |   41 ++++++++++++++++++----------------
 1 files changed, 22 insertions(+), 19 deletions(-)
---
diff --git a/programming-guidelines/C/index.page b/programming-guidelines/C/index.page
index 9f8b7c0..7244b50 100644
--- a/programming-guidelines/C/index.page
+++ b/programming-guidelines/C/index.page
@@ -17,6 +17,11 @@
       <name>Morten Welinder</name>
       <email its:translate="no">mortenw gnome org</email>
     </credit>
+    <credit type="author copyright">
+      <name>Philip Withnall</name>
+      <email its:translate="no">philip withnall collabora co uk</email>
+      <years>2015</years>
+    </credit>
     <credit type="publisher">
       <name>GNOME Foundation</name>
       <page xmlns="http://xmlns.com/foaf/0.1/";>http://foundation.gnome.org/</page>
@@ -24,23 +29,22 @@
 
     <include href="cc-by-sa-3-0.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
-    <desc>Gnome Programming Guidelines</desc>
+    <desc>GNOME Programming Guidelines</desc>
 
     <title type="link" role="trail">Programming Guidelines</title>
   </info>
 
-  <title>Gnome Programming Guidelines</title>
+  <title>GNOME Programming Guidelines</title>
 
   <p>
-    This article contains several guidelines and suggestions for Gnome
-    programmers, as well as certain policies that should be followed
-    when writing Gnome programs.  This is intended for programmers to
-    know about Gnome's development process and its philosophy.
-    Gnome is a team effort, so it will be useful for programmers to
-    know "the way things are done".  Think of this document not as a
-    book of laws, but rather as a manual of etiquette for writing
-    legible code that an be maintained by large, diverse teams over a
-    long period of time.
+    This article contains several guidelines and suggestions for programmers
+    working in and with the GNOME stack.  This is intended for programmers to
+    know about the development processes, conventions and philosophies behind
+    GNOME applications and the stack of libraries supporting them.  By knowing
+    “the way things are done” in the GNOME ecosystem, it is hoped that
+    programmers will find use of GNOME APIs and development of new applications
+    easier and more natural, and will produce code which is legible and
+    maintainable over a long period of time by a diverse team of programmers.
   </p>
 
   <p>
@@ -50,19 +54,18 @@
   <list>
     <item>
       <p>
-       To give you good suggestions on how to write code for Gnome.
-       This will help you write code that is consistent with Gnome's
-       practices, and that is well-accepted by the members of the
-       Gnome community.  This will also lead to code that is a
-       pleasure to work on.
+        To give you good suggestions on how to write code for GNOME or using
+        GNOME technologies. This will help you write code that is consistent
+        with best practices, and that will be accepted by the community.  This
+        will also lead to code that is a pleasure to work on.
       </p>
     </item>
 
     <item>
       <p>
-       To transmit the knowledge we have gotten over the years on how
-       to keep the Gnome project sustainable, even when people's
-       contributions increase or decrease.
+        To transmit the knowledge we have gotten over the years on how
+        to keep the GNOME project sustainable, even when people’s
+        contributions increase or decrease.
       </p>
     </item>
   </list>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]