From dbadd674c6fa74e41024b0a5b5d494af5a69f742 Mon Sep 17 00:00:00 2001 From: Sam Ruby Date: Wed, 2 Jun 2010 09:47:23 -0400 Subject: [PATCH] s/bzr/git/g --- docs/contributing.html | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/docs/contributing.html b/docs/contributing.html index 2cf95e1..42e8835 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -1,6 +1,4 @@ - + @@ -22,46 +20,46 @@ contribution.

Documentation can be found in the docs directory. It is straight XHTML.

Test cases can be found in the -tests directory, and +tests directory, and make use of the Python Unit testing framework. To run them, simply enter:

python runtests.py
-

Bzr

-

If you have done a bzr get, you have already set up +

Git

+

If you have done a git pull, you have already set up a repository. The only additional step you might need to do is to introduce -yourself to bzr. Type in the following, +yourself to git. Type in the following, after replacing the bold text with your information:

-
bzr whoami 'Your Name <youremail@example.com>'
+
git config --global user.name 'Your Name'
+git config --global user.email 'youremail@example.com'

Then, simply make the changes you like. When you are done, type:

-
bzr st
+
git status

This will tell you which files you have modified, and which ones you may have added. If you add files and you want them to be included, simply do a:

-
bzr add file1 file2...
+
git add file1 file2...
-

You can also do a bzr diff to see if there are any changes +

You can also do a git diff to see if there are any changes which you made that you don't want included. I can't tell you how many debug print statements I have caught this way.

Next, type:

-
bzr commit
+
git commit -a

This will allow you to enter a comment describing your change. If your repository is already on your web server, simple let others know where they -can find it. If not, you can simply ftp or scp the files to your web server -— no additional software needs to be installed on that machine.

+can find it. If not, consider using github to host your +fork of Venus.

Telling others

Once you have a change worth sharing, post a message on the -mailing list.

-

Also, consider setting up a bzr-feed for your repository, so people who wish to do so can automatically -be notified of every change.

-

There now is even an nascent planet being formed which combines these feeds of changes. You can subscribe to it too.

+mailing +list, or use github to send a pull request.