diff options
author | Will Kahn-Greene <willg@bluesock.org> | 2011-06-12 22:46:25 -0400 |
---|---|---|
committer | Will Kahn-Greene <willg@bluesock.org> | 2011-06-12 22:46:25 -0400 |
commit | fb6924170d0cc6b8648627edebc794e82b0946d7 (patch) | |
tree | df8637d9b59166d8d595a40b1cac3e5a6695b98e /docs | |
parent | 909c639d07aee08e2a3cd039e6fe4ae397dce5a7 (diff) | |
download | mediagoblin-fb6924170d0cc6b8648627edebc794e82b0946d7.tar.lz mediagoblin-fb6924170d0cc6b8648627edebc794e82b0946d7.tar.xz mediagoblin-fb6924170d0cc6b8648627edebc794e82b0946d7.zip |
Tweaks git workflow structure
* minor tweaking of the headers of the git workflow to break
things up and organize them a bit better
Diffstat (limited to 'docs')
-rw-r--r-- | docs/git.rst | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/docs/git.rst b/docs/git.rst index ddbcf226..9a44867a 100644 --- a/docs/git.rst +++ b/docs/git.rst @@ -23,10 +23,11 @@ Do:: git clone git://gitorious.org/mediagoblin/mediagoblin.git -How to send in patches -====================== +How to contribute changes +========================= -**Tie your changes to issues in the issue tracker** +Tie your changes to issues in the issue tracker +----------------------------------------------- All patches should be tied to issues in the `issue tracker <http://bugs.foocorp.net/projects/mediagoblin/issues>`_. That makes @@ -37,7 +38,9 @@ description of what it is you're trying to fix/implement, the better everyone else is able to understand why you're doing what you're doing. -**Use bugfix branches** + +Use bugfix branches to make changes +----------------------------------- The best way to isolate your changes is to create a branch based off of the MediaGoblin repository master branch, do the changes related to @@ -56,7 +59,9 @@ Further, if you isolate your changes to a branch, then you can work on multiple issues at the same time and they don't conflict with one another. -**Properly document your changes** + +Properly document your changes +------------------------------ Include comments in the code. @@ -68,7 +73,8 @@ Write comprehensive comments in the issue tracker about what you're doing and why. -**How to send us your changes** +How to send us your changes +--------------------------- There are three ways to let us know how to get it: |