summaryrefslogtreecommitdiff
path: root/developers.html
blob: 07f7907b5fc0030dff505b7c976b23e70e66f217 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
<html>
    <head>
        <title>Community Cheetah - The Python-Powered Template Engine - Developers</title>
        <meta http-equiv="content-type" content="application/xhtml+xml; charset=UTF-8"/>
        <meta name="keywords" content="cheetah, template engine, python, community cheetah, templating, markdown, markup, mod_python, webware"/>
        <meta name="googlebot" content="index, follow" />
        <meta name="language" content="en-us, english" />

        <link rel="stylesheet" type="text/css" href="stylesheet.css" media="screen, projection, tv" />
    </head>
    <body>

        <a href="http://github.com/rtyler/cheetah">
    <img style="position: absolute; top: 0; left: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_left_orange_ff7600.png" alt="Fork me on GitHub" />
</a>
    <div id="blogtitle">
            <div id="small" style="margin-left: 130px;"><a href="#">Community Cheetah</a> </div>
            <div id="small2">
                    <a href="index.html">Home</a>&nbsp;|&nbsp;
                    <a href="http://bugs.communitycheetah.org">Issues</a>&nbsp;|&nbsp;
                    <a href="http://github.com/rtyler/cheetah/tree/master">Source</a>&nbsp;|&nbsp;
                    <a href="roadmap.html">Roadmap</a>&nbsp;|&nbsp;
            </div>
    </div>
            
    <div id="topmenu">
        <ul class="BLUE">
                <li>
                    <a href="index.html" title="Home">
                        <span>Home</span>
                    </a>
                </li>
                <li>
                    <a href="download.html" title="Download">
                        <span>Download</span>
                    </a>
                </li>
                <li>
                    <a href="docs.html" title="Documentation">
                        <span>Documentation</span>
                    </a>
                </li>
                <li>
                    <a href="recipes.html" title="Recipes">
                        <span>Recipes</span>
                    </a>
                </li>
                <li>
                    <a href="community.html" title="Community">
                        <span>Community</span>
                    </a>
                </li>
                <li>
                    <a href="developers.html" title="Developers">
                        <span>Developers</span>
                    </a>
                </li>
        </ul>
    </div>



        <div id="centercontent">
           <h1>Contributing to Cheetah</h1>
<p>Cheetah is the work of many volunteers. If you use Cheetah, share your experiences, tricks, customizations, and frustrations. 
Please join the <a href="http://lists.sourceforge.net/lists/listinfo/cheetahtemplate-discuss">mailing list</a>.</p>
<h2>Fork Me!</h2>
<p>Community Cheetah is hosted by <a href="http://www.github.com">GitHub</a> which encourages forking of projects in order
to facilitate truly distributed and decentralized development. That is not to say that Community Cheetah is
"decentralized" per s&eacute; but rather it's ready for community involvement from the get-go! To get started
with contributing to Community Cheetah, it's a good idea to clone the "central" Git repo <a href="http://github.com/rtyler/cheetah">here</a>.</p>
<h2>Development Process</h2>
<p>The typical development workflow for Community Cheetah revolves around two primary branches <strong>maint</strong> and <strong>next</strong>.
The <strong>next</strong> branch is where development planned for the next release of Community Cheetah is. The <strong>maint</strong> branch
on the otherhand is where backported fixes and patches will be applied for the <em>current</em> release of Community Cheetah
will go, it's common for a patch to be applied to <strong>maint</strong> and <strong>next</strong> at the same time.</p>
<h2>Bug reports and patches</h2>
<p>If you have stubmled across a bug or have an improvement to suggest in Cheetah please consider reporting 
the issue into Community Cheetah's <a href="http://bugs.communitycheetah.org">bug tracker</a> or emailing the 
<a href="http://lists.sourceforge.net/lists/listinfo/cheetahtemplate-discuss">mailing list</a>.</p>
<p>Please try to include the following bits of information:</p>
<ul>
<li>A description of what you were trying to do, and what happened (i.e. reproduction steps)</li>
<li>Any and all tracebacks or compiler errors</li>
<li>The version of Cheetah you're using</li>
<li>The version of Python you're using</li>
<li>The operating system you're running Cheetah on</li>
<li>Any other pieces of information you might think are relevant</li>
</ul>
<h2>Example sites and tutorials</h2>
<p>If you're developing a website with Cheetah, please send a link to the email list so we can keep track of Cheetah sites. Also, if you discover new and interesting ways to use Cheetah please share your experience and write a quick tutorial about your technique.</p>
<h2>Test cases</h2>
<p>Cheetah is packaged with a regression testing suite that is run with each new release to ensure that everything is working as expected and that recent changes haven't broken anything. The test cases are in the Cheetah.Tests module. If you find a reproduceable bug please consider writing a test case that will pass only when the bug is fixed. Send any new test cases to the email list with the subject-line "new test case for Cheetah."</p>
        </div>

        <div id="rightcontent">
            <img style="margin-top:-9px; margin-left: -5px;" src="images/top2.jpg" alt="" />
            
                <div id="twitter_div">
        <h2 class="sidebar-title">Twitter Updates</h2>
        <ul id="twitter_update_list"></ul>

        <a href="http://twitter.com/cheetahtemplate" id="twitter-link" style="display:block;text-align:right;">follow Cheetah on Twitter</a>
    </div>


            <img style="padding-top:5px; margin-left:-5px; margin-bottom:-4px;" src="images/specs_bottom.jpg" alt="" />
        </div>

        <br clear="all"/>
        <br/>

            <a href="http://www.python.org" target="_blank"><img src="images/python-logo.gif" border="0" alt="Python-powered" title="Python-powered" align="right"/></a>
    <br clear="all"/>
    <br/>
    <div id="footer">
        &copy; 2006 Design by <a href="http://www.studio7designs.com">Studio7designs.com</a>
    </div>


        <script type="text/javascript" src="http://twitter.com/javascripts/blogger.js"></script>
        <script type="text/javascript" src="http://twitter.com/statuses/user_timeline/cheetahtemplate.json?callback=twitterCallback2&count=5"></script> 
	</body>
</html>