[gnome-builder] doc: start on contribution guide
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-builder] doc: start on contribution guide
- Date: Wed, 22 Feb 2017 09:40:49 +0000 (UTC)
commit 6ed49fbb4ce9387984ab5c36dabca8ceb33b18a8
Author: Christian Hergert <chergert redhat com>
Date: Wed Feb 22 01:40:39 2017 -0800
doc: start on contribution guide
doc/contributing.rst | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++
doc/index.rst | 1 +
2 files changed, 79 insertions(+), 0 deletions(-)
---
diff --git a/doc/contributing.rst b/doc/contributing.rst
new file mode 100644
index 0000000..22ed52c
--- /dev/null
+++ b/doc/contributing.rst
@@ -0,0 +1,78 @@
+############
+Contributing
+############
+
+If you're interested in contributing to Builder and GNOME at large, we would love for you to join us!
+Only with people like you can GNOME exist.
+We love seeing people that use GNOME transform into people that create GNOME.
+
+IRC
+===
+
+One great way to get started is to join us on IRC where you can chat with others who work on the Builder
project.
+The Builder developer team can be found on the `Builder IRC channel`_.
+
+File A Bug
+==========
+
+If you think you've found a bug in Builder, head over to `Builder Bug Tracker`_ and file a report.
+We will get back to you on any further details we need to track down the issue as soon as we can.
+Filing bugs helps us improve the softwrae for everyone and we really appreciate your time.
+
+For various spam reasons our bugtracker requires that you create an account.
+We hope this minor inconvenience is not too much trouble.
+
+Find a Bug To Work On
+=====================
+
+If you wish to start contributing code to Builder, simply pick a bug from this list of `newcomer bugs`_.
+
+Building From Source
+====================
+
+One of the first steps to joining a software project is to build the software.
+Check out the `GNOME Newcomers Tutorial`_ for how to build software for GNOME.
+It includes a guide for how to build Builder, as well as many other GNOME software projects.
+
+For the impatient, you can use ``jhbuild`` to simplify the build process.
+
+.. note::
+
+ We do not recommend installing jhbuild using your Linux distributions package manager as
+ it will be out of date.
+
+.. code-block:: sh
+
+
+ git clone git://git.gnome.org/jhbuild.git
+ cd jhbuild
+ ./autogen.sh --simple-install
+ make
+ make install
+ jhbuild sysdeps --install gnome-builder
+ jhbuild build gnome-builder
+ jhbuild run gnome-builder
+
+Improve This Documentation
+==========================
+
+One great way to learn about a software project is to try to document it!
+Writing great documentation can be both challenging and rewarding.
+And writing great documentation requires you learn about the product.
+
+This is one way to improve things for the next person while you explore the code-base.
+You can find the documentation in the ``doc/`` directory of the `git repository`_.
+
+Planning and Project Management
+===============================
+
+Many of us that work on the Builder code-base are great at writing code.
+But we are not so great at managing schedules, planning feature priorities, and coordinating with other
projects.
+Helping us do this in Builder will make you a shepard of geeks.
+
+.. _`Builder IRC channel`: irc://irc.gnome.org/#gnome-builder
+.. _`Builder Bug Tracker`: https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-builder
+.. _`newcomer bugs`:
https://bugzilla.gnome.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&columnlist=component%2Cchangeddate%2Cbug_severity%2Cpriority%2Cshort_desc&keywords=newcomers&list_id=193415&order=changeddate%20DESC%2Ccomponent&product=gnome-builder&resolution=---
+.. _`GNOME Newcomers Tutorial`: https://wiki.gnome.org/Newcomers/BuildGnome
+.. _`git repository`: https://git.gnome.org/browse/gnome-builder/tree
+
diff --git a/doc/index.rst b/doc/index.rst
index 02b7f82..b468f8c 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -19,4 +19,5 @@ Contents
introduction
plugins/index
api/index
+ contributing
credits
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]