[gnome-boxes] Add HACKING



commit ec9094c3cddac3bc872d9f6857fbd9b5af3b5693
Author: Lasse Schuirmann <lasse schuirmann net>
Date:   Wed Mar 12 22:19:23 2014 +0100

    Add HACKING
    
    The HACKING file contains information for people interested in getting
    started in developing Boxes.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=726115

 HACKING |   52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 README  |    2 +-
 2 files changed, 53 insertions(+), 1 deletions(-)
---
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..a2d1a8f
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,52 @@
+HACKME
+======
+
+If you are just interested in knowing how to post a bug you've found, just
+read the section "Reporting Bugs" in README and follow the instructions.
+
+This file is intended to help new developers to get started with developing
+for Boxes. Feel free to skip sections if you know what they are about.
+
+Another good source for general information is:
+
+ https://wiki.gnome.org/Apps/Boxes
+
+1. How to Provide a Good Patch
+==============================
+
+* Read the CodingStyle.txt.
+* Make sure you have just what belongs there in the changeset.
+* Read https://wiki.gnome.org/Git/CommitMessages carefully.
+* The preferred way of appending patches to bugs is via git bz.
+  * As an alternative you can use "git format-patch HEAD~1".
+* The bugtracker has some quite cool features; use them!
+* Click on review to write comments to other or your patches or to comment
+  comments on these patches
+* Dont be afraid about criticism! The review process is probably going to be long.
+* We dont dislike you! We really appreciate your work.
+
+2. Getting Started With Vala
+============================
+
+Check out:
+
+ https://wiki.gnome.org/Projects/Vala/Documentation
+
+Vala basics in 5 minutes:
+
+ https://www.youtube.com/watch?v=k9hE0mumsCM
+
+Good reference for the libraries used here:
+
+ http://www.valadoc.org/
+
+Information about UI-templates:
+
+ http://blogs.gnome.org/tvb/2013/05/29/composite-templates-lands-in-vala/
+
+3. Getting Started With Boxes
+=============================
+
+The best way to get started is to fix small bugs. If you don't find them, ask
+on IRC.
+
diff --git a/README b/README
index 207cab1..eda03cf 100644
--- a/README
+++ b/README
@@ -55,7 +55,7 @@ include
 * a backtrace if the program crashes (See Appendix 1)
 * debug messages if it makes sense (See Appendix 2)
 * a fix if you have one (This greatly increases the chances of this issue
-  getting fixed soon.)
+  getting fixed soon. See HACKING, section 2 for how to provide a good patch.)
 
 The determination of what is useful is your task. If you forget about
 something important, someone will probably ask.


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