Skip to content

Commit 6311085

Browse files
committed
adding a contributing page
1 parent 9a3d203 commit 6311085

File tree

3 files changed

+115
-1
lines changed

3 files changed

+115
-1
lines changed

CONTRIBUTING.rst

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
============
2+
Contributing
3+
============
4+
5+
Contributions are welcome and greatly appreciated!
6+
7+
You can contribute in many ways:
8+
9+
Types of Contributions
10+
----------------------
11+
12+
Fix Typos, Grammar Errors, etc
13+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14+
15+
Create pull requests at
16+
https://github.com/makaimc/fullstackpython.github.com/pulls.
17+
18+
19+
Submit Feedback
20+
~~~~~~~~~~~~~~~
21+
22+
The best way to send feedback is to file an issue at
23+
https://github.com/makaimc/underwear/issues.
24+
25+
26+
Get Started!
27+
------------
28+
29+
If you're not familiar with `Pelican <http://docs.getpelican.com/>`_, check out the blog post on
30+
`Getting Started with Pelican and GitHub Pages <http://www.mattmakai.com/introduction-to-pelican.html>`_.
31+
32+
Ready to contribute? Here's how to set up Full Stack Python for local
33+
development.
34+
35+
1. Fork the `fullstackpython.github.com <https://github.com/makaimc/fullstackpython.github.com>`_ repo on GitHub.
36+
37+
2. Clone your fork locally::
38+
39+
$ git clone git@github.com:your_name_here/fullstackpython.github.com.git fsp
40+
41+
3. Install your local copy into a virtualenv and set up your fork for local development::
42+
43+
$ virtualenv --no-site-packages venvs/fsp
44+
$ source venvs/fsp/bin/activate
45+
$ cd fsp
46+
47+
Note: make changes to the content/pages/\*.rst files then perform a
48+
*make run* command from the source/ directory.
49+
50+
6. Commit your changes and push your branch to GitHub::
51+
52+
$ git add .
53+
$ git commit -m "Your detailed description of your changes."
54+
$ git push origin gh-pages
55+
56+
7. Submit a pull request through the GitHub website.
57+

feeds/all.atom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<feed xmlns="http://www.w3.org/2005/Atom"><title>Matt Makai</title><link href="http://www.fullstackpython.com/" rel="alternate"></link><link href="http://www.fullstackpython.com/feeds/all.atom.xml" rel="self"></link><id>http://www.fullstackpython.com/</id><updated>2014-02-05T16:01:08Z</updated></feed>
2+
<feed xmlns="http://www.w3.org/2005/Atom"><title>Matt Makai</title><link href="http://www.fullstackpython.com/" rel="alternate"></link><link href="http://www.fullstackpython.com/feeds/all.atom.xml" rel="self"></link><id>http://www.fullstackpython.com/</id><updated>2014-02-05T16:18:13Z</updated></feed>
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
============
2+
Contributing
3+
============
4+
5+
Contributions are welcome and greatly appreciated!
6+
7+
You can contribute in many ways:
8+
9+
Types of Contributions
10+
----------------------
11+
12+
Fix Typos, Grammar Errors, etc
13+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14+
15+
Create pull requests at
16+
https://github.com/makaimc/fullstackpython.github.com/pulls.
17+
18+
19+
Submit Feedback
20+
~~~~~~~~~~~~~~~
21+
22+
The best way to send feedback is to file an issue at
23+
https://github.com/makaimc/underwear/issues.
24+
25+
26+
Get Started!
27+
------------
28+
29+
If you're not familiar with `Pelican <http://docs.getpelican.com/>`_, check out the blog post on
30+
`Getting Started with Pelican and GitHub Pages <http://www.mattmakai.com/introduction-to-pelican.html>`_.
31+
32+
Ready to contribute? Here's how to set up Full Stack Python for local
33+
development.
34+
35+
1. Fork the `fullstackpython.github.com <https://github.com/makaimc/fullstackpython.github.com>`_ repo on GitHub.
36+
37+
2. Clone your fork locally::
38+
39+
$ git clone git@github.com:your_name_here/fullstackpython.github.com.git fsp
40+
41+
3. Install your local copy into a virtualenv and set up your fork for local development::
42+
43+
$ virtualenv --no-site-packages venvs/fsp
44+
$ source venvs/fsp/bin/activate
45+
$ cd fsp
46+
47+
Note: make changes to the content/pages/\*.rst files then perform a
48+
*make run* command from the source/ directory.
49+
50+
6. Commit your changes and push your branch to GitHub::
51+
52+
$ git add .
53+
$ git commit -m "Your detailed description of your changes."
54+
$ git push origin gh-pages
55+
56+
7. Submit a pull request through the GitHub website.
57+

0 commit comments

Comments
 (0)