summaryrefslogtreecommitdiffstats
path: root/doc/development/setup.txt
diff options
context:
space:
mode:
authorSol Jerome <sol.jerome@gmail.com>2013-07-14 14:18:31 -0500
committerSol Jerome <sol.jerome@gmail.com>2013-07-14 14:18:31 -0500
commit15f003dfbb208a826818faaba76a1b5a3bc0a959 (patch)
treefaffbf9411c6e2f252efd9254de9a4714a49bda3 /doc/development/setup.txt
parent5a2194e3778160474b8e1c6c9c0da882746f5b8c (diff)
downloadbcfg2-15f003dfbb208a826818faaba76a1b5a3bc0a959.tar.gz
bcfg2-15f003dfbb208a826818faaba76a1b5a3bc0a959.tar.bz2
bcfg2-15f003dfbb208a826818faaba76a1b5a3bc0a959.zip
doc: Add documentation for submitting patches
This should provide potential contributors with enough information to allow them to more easily create pull requests or send patches (especially for those who are not familiar with git). Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
Diffstat (limited to 'doc/development/setup.txt')
-rw-r--r--doc/development/setup.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/development/setup.txt b/doc/development/setup.txt
index 05ad4157f..42aa0b023 100644
--- a/doc/development/setup.txt
+++ b/doc/development/setup.txt
@@ -1,4 +1,5 @@
.. -*- mode: rst -*-
+.. vim: ft=rst
.. _development-setup:
@@ -12,6 +13,11 @@ Checking Out a Copy of the Code
git clone https://github.com/Bcfg2/bcfg2.git
+.. note::
+
+ The URL above is read-only. If you are planning on submitting patches
+ upstream, please see :ref:`development-submitting-patches`.
+
* Add :file:`bcfg2/src/sbin` to your :envvar:`PATH` environment variable
* Add :file:`bcfg2/src/lib` to your :envvar:`PYTHONPATH` environment variable