pyjs.org/Contribute.html at gh-pages · pyjsorg/pyjs.org · GitHub

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
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xml:lang="en" lang="en" xmlns="http://www.w3.org/1999/xhtml">

<head>
    <title>Pyjs</title>
    <link rel="stylesheet" type="text/css" media="screen" href="assets/main.css"/>
</head>

<body>
<div id="menu">
    <div id="logo"><a href="./" title="Pyjs!"><img src="assets/images/pyjs.128x128.png" alt="Pyjs Logo" /></a></div>

<ul class="simple">
<li class="section">About</li>
<li><a class="reference external" href="About.html">About</a></li>
<li><a class="reference external" href="Overview.html">Overview</a></li>
<li><a class="reference external" href="Translator.html">Translator</a></li>
<li><a class="reference external" href="Download.html">Download</a></li>
<li><a class="reference external" href="GettingHelp.html">Getting Help</a></li>
<li class="section">Documentation</li>
<li><a class="reference external" href="examples">Examples</a></li>
<li><a class="reference external" href="UIHierarchy.html">UI Hierarchy</a></li>
<li><a class="reference external" href="api">API Docs</a></li>
<li><a class="reference external" href="book/Bookreader.html">Book</a></li>
<li><a class="reference external" href="https://github.com/pyjs/pyjs/wiki">Wiki</a></li>
<li class="section">Development</li>
<li><a class="reference external" href="Developing.html">Develop</a></li>
<li><a class="reference external" href="Optimize.html">Optimize</a></li>
<li><a class="reference external" href="Contribute.html">Contribute</a></li>
<li><a class="reference external" href="Roadmap.html">Roadmap</a></li>
</ul>

</div>
<div id="body">
<h1 class="title">Contribute</h1>
<div class="section" id="general-instructions">
<h1>General Instructions</h1>
<p>Contributing is easy with <a class="reference external" href="https://github.com/pyjs">GitHub</a>: Simply fork the project, apply your changes, and make a pull request. (If you are not yet familiar with GitHub, you'll find the &quot;Fork&quot; and &quot;Pull Request&quot; buttons on the top right of the pyjs project page.) Your pull request will then be reviewed and merged into pyjs' main repository by one of the project administrators.</p>
</div>
<div class="section" id="adding-gwt-widgets-to-pyjs">
<h1>Adding GWT Widgets to pyjs</h1>
<p>To convert one of Google's GWT widgets (written for Java) to pyjs please use the <tt class="docutils literal">java2py.py</tt> script from the <a class="reference external" href="https://github.com/pyjs/pyjs/blob/master/contrib">contrib folder</a>.</p>
</div>
<div class="section" id="helping-out-with-bugs">
<h1>Helping Out With Bugs</h1>
<p>If you find a bug have it confirmed by the <a class="reference external" href="GettingHelp.html">mailing list</a>, and add a bug report. If you want to help out, but don't know where to start please pick a bug that you think you can handle from one of our bug trackers:</p>
<ul class="simple">
<li><a class="reference external" href="https://github.com/pyjs/pyjs/issues">pyjs bug tracker</a> (source issues)</li>
<li><a class="reference external" href="https://github.com/pyjs/pyjs.org/issues">pyjs.org bug tracker</a> (website issues)</li>
</ul>
</div>
<div class="section" id="pyjs-developer-guidelines">
<h1>pyjs Developer Guidelines</h1>
<p>In the pyjs repository is a file <a class="reference external" href="https://github.com/pyjs/pyjs/blob/master/DEVELOPER.RULES">DEVELOPER.RULES</a>. This is a good starting point.</p>
<p>The trickiest part about pyjs is remembering that it is several separate projects.  For example: modifying the JavaScript compiler has absolutely nothing to do with pyjs Desktop.  But, modifying a pyjs UI Widget requires testing on <strong>eight</strong> platforms (five web and three desktop) including compiling and testing using both <tt class="docutils literal"><span class="pre">--strict</span></tt> and <tt class="docutils literal"><span class="pre">-O</span></tt> on the five web platforms, and testing under nearly <strong>ten</strong> web browsers (Firefox 2 to 4; Opera 9 to 10.5; Safari 3 and 4; Google Chrome; IE 6 and above, and so on).  Clearly, this is an impossible task but you should make the best efforts and use your judgement, and ask for help on the mailing list.</p>
<p>Lastly - please use the <a class="reference external" href="https://github.com/pyjs/pyjs/issues">bugtracker</a> to report bugs (regardless of how trivial or small); the mailing list to coordinate discussions; the <a class="reference external" href="https://github.com/pyjs/pyjs/wiki">pyjs wiki</a> to create HOWTOs and so on.</p>
</div>
</div>
</body>
</html>