Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

executable file 171 lines (144 sloc) 6.507 kb
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" id="mysite-com">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Git for Writers: Participate</title>
<link rel="stylesheet" type="text/css" media="screen, print" href="css/reset.css" />
<link rel="stylesheet" type="text/css" media="screen" href="css/screen.css" />
<!--[if lte IE 7>
<link rel="stylesheet" type="text/css" media="screen" href="css/screen-ie.css" />
<![endif]-->
<link rel="stylesheet" type="text/css" media="print" href="css/print.css" />
<!--REMOVE COMMENT TAGS TO USE FACEBOOK SHARE METADATA:-->
<!--
<meta name="title" content="Match this with the content of the title tag above." />
<meta name="description" content="A short description of this page." />
<link rel="image_src" href="http://example.com/media/share/thumbnail.jpg" />
-->
<!--REMOVE COMMENT TAGS TO USE FAVICON LINKS:-->
<!--
<link rel="icon" href="" type="image/png" />
<link rel="shortcut icon" href="" type="image/png" />
-->
<script type="text/javascript" src="js/mootools/mootools-core.js"></script>
<script type="text/javascript" src="js/site.js"></script>
</head>
<body>
<div id="page">
<div id="header">
<h1><a href="http://gewga.ws/git-for-writers/" rel="home">Git for Writers</a></h1>
<p class="tagline">
A guide to version tracking, revision, and collaboration for open-source writing.
</p>
<ul class="accessibility">
<li><a href="#navigation">Jump to Navigation</a></li>
<li><a href="#content">Jump to Content</a></li>
</ul>
</div>
<div id="content">
<div id="main">
<h2>How to Participate in Writing <cite>Git for Writers</cite></h2>
<p>
<cite>Git for Writers</cite> is an open project, and we welcome contributions from
anyone interested in helping writers benefit from using <a href="http://git-scm.com">Git</a>
and <a href="http://github.com">GitHub</a> and related services.
</p>
<h3>What You'll Need</h3>
<p>
To contribute to the project, as well as to use Git in your own work, you need:
</p>
<ol>
<li>
An <a href="http://book.git-scm.com/2_installing_git.html">installation</a> of Git on your computer,
configured with your name and email address (free)
</li>
<li>A GitHub <a href="https://github.com/signup/free">account</a> (free)</li>
<li>
A private/public keypair for accessing your GitHub account; this may also mean
installing <a href="http://www.openssh.com/windows.html">OpenSSH</a> on your computer if you are a Windows user.
</li>
</ol>
<h3>What You'll Do to Get a Copy to Edit</h3>
<p>
Once you have Git, your GitHub account, and your keys and OpenSSH active,
participating in the project is pretty simple:
</p>
<ol>
<li>
After logging into your GitHub account, go to
<a href="http://github.com/gewgaws/git-for-writers">the Git for Writers
repository</a> (repo) and fork a copy to your GitHub account by clicking
on the Fork button.
</li>
<li>
Once you have forked <cite>Git for Writers</cite>, you should do an initial
pull from your copy of the repo by running <br />
<kbd>git pull git@github.com:<strong>youraccount</strong>/git-for-writers.git</kbd>,
replacing <kbd><strong>youraccount</strong></kbd> with the name of your GitHub
account.
</li>
</ol>
<h3>How to Edit Your Copy</h3>
<p>
The only thing you need to edit is a plain text editor; TextWrangler is a good
option for Mac users; Windows users might want to check out Notepad++ (which is
different from the Notepad that's included with windows.
</p>
<p>
Git for Writers has <a href="style-guide.htm">its own style guide</a>, which you
should follow. Check out some of our existing pages (such as this one,
which is <code>participate.htm</code> in the repo) to see how we indent HTML
and CSS to keep it maximally readable. (You can also choose View > Source in your
Web browser.
</p>
<h3>How to Keep Your Copy Current</h3>
<p>
To make sure you have the latest changes to the project, you'll want to set up a
tracking branch
(<a href="http://github.com/guides/keeping-a-git-fork-in-sync-with-the-forked-repo">read
these GitHub instructions</a>) and pull from and merge that branch regularly. In Git, you can just run
<kbd>git remote add gewgaws git://github.com/gewgaws/git-for-writers.git</kbd>; to
pull from that, run <kbd>git pull gewgaws master</kbd> into your tracking branch.
</p>
<h3>What You'll Do to Submit Your Work</h3>
<p>
When you are ready to submit your work, be sure you have pushed to your copy of the
Git for Writers repo on your GitHub account. Make sure you're logged into GitHub
and navigate to the
<a href="http://github.com/gewgaws/git-for-writers">the Git for Writers
repository</a>. Click the Pull Request button, and select <strong>gewgaws</strong>
as the recepient. Explain clearly in your message what your contribution to Git for
Writers includes.
</p>
</div>
<div id="supporting">
</div>
</div>
<ul id="navigation">
<li><a href="index.htm">Home</a></li>
<li><a href="resources.htm">Resources</a></li>
<li><a href="about.htm">About</a></li>
</ul>
<div id="footer">
<p class="copyright">
© 2010 by Gewgaws Lab. Some rights reserved. Content licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/">
Creative Commons Attribution-Share Alike 3.0 United States License
</a>.
<a class="cc-badge" rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/">
<img alt="Creative Commons License" src="http://i.creativecommons.org/l/by-sa/3.0/us/88x31.png" />
</a>
</p>
<p class="project-information">
<a href="http://github.com/gewgaws/git-for-writers">Git for Writers repository</a>
hosted at <a href="http://github.com">GitHub</a>. Learn <a href="participate.htm">how to
contribute</a> to Git for Writers.
</p>
<ul class="validators">
<li><a href="http://validator.w3.org/check?uri=referer" title="Validate this page's XHTML">XHTML</a></li>
<li><a href="http://jigsaw.w3.org/css-validator/check/referer" title="Validate this page's CSS">CSS</a></li>
</ul>
</div>
</div>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.