-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdevelopers.html
More file actions
161 lines (154 loc) · 8.1 KB
/
developers.html
File metadata and controls
161 lines (154 loc) · 8.1 KB
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Contributing to Cheetah — Cheetah3 - The Python-Powered Template Engine</title>
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Downloading Cheetah" href="download.html" />
<link rel="prev" title="News" href="news.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="download.html" title="Downloading Cheetah"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="news.html" title="News"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Cheetah3 - The Python-Powered Template Engine</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Contributing to Cheetah</a><ul>
<li><a class="reference internal" href="#getting-the-code">Getting the Code</a></li>
<li><a class="reference internal" href="#development-process">Development Process</a></li>
<li><a class="reference internal" href="#filing-bugs">Filing Bugs</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="news.html"
title="previous chapter">News</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="download.html"
title="next chapter">Downloading Cheetah</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/developers.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="contributing-to-cheetah">
<h1>Contributing to Cheetah<a class="headerlink" href="#contributing-to-cheetah" title="Permalink to this headline">¶</a></h1>
<p>Cheetah is the work of many volunteers. If you use Cheetah, share your
experiences, tricks, customizations, and frustrations. Please visit
<a class="reference external" href="https://github.com/CheetahTemplate3/cheetah3">https://github.com/CheetahTemplate3/cheetah3</a> and file bug reports, feature
requests or pull requests.</p>
<div class="section" id="getting-the-code">
<h2>Getting the Code<a class="headerlink" href="#getting-the-code" title="Permalink to this headline">¶</a></h2>
<p>The Cheetah source code is stored in a central <strong>Git</strong> repository
hosted primarily by <a class="reference external" href="http://github.com">GitHub</a>. The primary Git
repository can be found <a class="reference external" href="http://github.com/CheetahTemplate3/cheetah3">here</a>.</p>
</div>
<div class="section" id="development-process">
<h2>Development Process<a class="headerlink" href="#development-process" title="Permalink to this headline">¶</a></h2>
<p>The typical development workflow for 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 Cheetah is. The <strong>maint</strong> branch
on the otherhand is where backported fixes and patches will be applied for
the current release of Cheetah will go, it’s common for a patch
to be applied to maint and next at the same time.</p>
<p>Anyone and everyone is encouraged to submit patches at any time, but as far
as bugs or feature requests go, we try to file those <em>first</em> in the <a class="reference external" href="https://github.com/CheetahTemplate3/cheetah3/issues">Cheetah3 Bug Tracker</a>
and then they can be organized into particular releases as is necessary.</p>
<p>In addition to the bug tracker, Cheetah uses Github Actions
for automating builds and test runs (see: <a class="reference external" href="https://github.com/CheetahTemplate3/cheetah3/actions">Github Actions for Cheetah</a>).</p>
<p>Prior to the tarballing of a release, <strong>all</strong> tests must be passing before the
<strong>next</strong> branch is merged down to the Git <strong>master</strong> branch where the release
tarball will actually be created from.</p>
</div>
<div class="section" id="filing-bugs">
<h2>Filing Bugs<a class="headerlink" href="#filing-bugs" title="Permalink to this headline">¶</a></h2>
<p>No software is perfect, and unfortunately no bug report is either. If you’ve
found yourself faced with a bug in Cheetah, or just have a good idea for a
new feature, we kindly ask that you create an issue in the <a class="reference external" href="https://github.com/CheetahTemplate3/cheetah3/issues">Cheetah3 Bug Tracker</a>.</p>
<p>Some tips for filing a <em>useful</em> bug report, try to include the following:</p>
<ul class="simple">
<li>A description of what you were trying to do, and what happened (i.e. reproduction steps), the more code you can include the better.</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>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="download.html" title="Downloading Cheetah"
>next</a> |</li>
<li class="right" >
<a href="news.html" title="News"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Cheetah3 - The Python-Powered Template Engine</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2017-2025, Oleg Broytman; 2009-2012, R. Tyler Croy; 2001-2008, The Cheetah Development Team..
Last updated on Nov 29, 2025.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.6.
</div>
</body>
</html>