-
Notifications
You must be signed in to change notification settings - Fork 5
/
how-to-contribute.html
132 lines (106 loc) · 6.58 KB
/
how-to-contribute.html
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
<!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">
<!--
(c) 2005, 2009, 2010 ThoughtWorks Ltd. All rights reserved.
(c) 2015 ProxyToys Committers. All rights reserved.
The software in this package is published under the terms of the BSD
style license a copy of which has been included with this distribution in
the LICENSE.txt file.
Created on 07-May-2005
-->
<head>
<title>ProxyToys - How to Contribute</title>
<link rel="stylesheet" type="text/css" href="style.css"/>
</head>
<body>
<div id="banner">
<a href="index.html"><img id="logo" src="logo.gif" alt="ProxyToys Logo"/></a>
<div id="title">How to Contribute</div>
</div>
<div id="center" class="Content2Column">
<div id="content">
<p>ProxyToys is nothing without contributions from the user community. There are many ways to
contribute. We are constantly working on the software and documentation, so it's a good
idea to contact the team on the <a href="mailing-lists.html">user or development mailing lists</a>
to avoid duplicating effort.</p>
<h1 id="documentation">Documentation</h1>
<p>One of the traditional weak points of open source software is the documentation. Any
help with this aspect of the project will be welcomed with open arms, or at the very least
with open email clients!</p>
<p>The documentation is in plain HTML and
<a href="https://github.com/proxytoys/proxytoys/tree/master/website/src/site/content/">held in Git</a></p>
<h1 id="examples">Examples</h1>
<p>We are working on examples of using ProxyToys, but we can always do with more.</p>
<p>The examples are proper Java source files and
<a href="https://github.com/proxytoys/proxytoys/tree/master/example-code/src/main/java/proxytoys/examples/overview/">
held in Git</a></p>
<h1 id="feature-requests">Feature Requests</h1>
<p>If you want to request a new feature you can either make a request through the
<a href="https://github.com/proxytoys/proxytoys/issues">issue tracker</a> or by sending a message to the
<a href="mailing-lists.html">development mailing list</a>. The benefit of any new features
will be discussed on the mailing list, so its a good idea to sign up so that you can make your voice heard.</p>
<h1 id="bug-reports">Bug Reports</h1>
<p>You can report bugs through the <a href="https://github.com/proxytoys/proxytoys/issues">issue tracker</a> (preferred)
interface or the <a href="mailing-lists.html">development mailing list</a>. We love bug reports that
include a failing unit test.</p>
<h1 id="patches">Bug Fixes</h1>
<p>Better than issues in the bug tracker with failing unit tests, are issues with unit tests, <b>and</b> a fix.
Bug fixes are best sent as patches that we can apply to the
codebase. Remember to tell us which version the patch should be applied against if not the current trunk, or
we could get very confused. To be accepted into the codebase, patches must be released
under the <a href="license.html">same license as ProxyToys itself</a>.</p>
<h1 id="new-code">New Code</h1>
<p>If you have a new feature request, then we'll listen extra hard if you show us how it
works. A new feature might be best implemented as a patch to an existing class
or as a new class. The ProxyToys API contains many extension points that allow new functionality
to be integrated into the framework. We are rather strict about testing, so if you send us
some code without any tests we will probably ask you to write the tests tests as well
before we add it to the codebase.</p>
<h1 id="your-own-extension">Write Your Own ProxyToys Extension</h1>
<p>If you have a project that builds upon ProxyToys, and are unwilling to donate, then we will be happy to announce your
project on the ProxyToys site.</p>
<h1>Become a Committer</h1>
<p>Simply show some interest in bug fixes and submissions, we'll expand the core team easily.</p>
<br/><br/>
</div>
</div>
<div class="SidePanel" id="left">
<div class="MenuGroup">
<h1>ProxyToxy in General</h1>
<ul>
<li><a href="index.html">About ProxyToys</a></li>
<li><a href="news.html">News</a></li>
<li><a href="changes.html">Change History</a></li>
<li><a href="license.html">License</a></li>
<li><a href="download.html">Download</a></li>
<li><a href="versioning.html">About Versioning</a></li>
</ul>
</div>
<div class="MenuGroup">
<h1>Using ProxyToys</h1>
<ul>
<li><a href="tutorial.html">One minute Tutorial</a></li>
<li><a href="factories.html">Proxy Factories</a></li>
<li><a href="toys.html">Toys</a></li>
<li><a href="faq.html">Frequently Asked Questions</a></li>
<li><a href="example-code.html">Example Code</a></li>
<li><a href="mailing-lists.html">Mailing Lists</a></li>
<li><a href="apidocs/index.html">Javadoc</a></li>
<li><a href="issues.html">Reporting Issues</a></li>
</ul>
</div>
<div class="MenuGroup">
<h1>Developing ProxyToys</h1>
<ul>
<li><a href="architecture.html">Architecture Overview</a></li>
<li class="currentLink">How to Contribute</li>
<li><a href="team.html">Development Team</a></li>
<li><a href="repository.html">Source Repository</a></li>
<li><a href="https://github.com/proxytoys/proxytoys">GitHub Project</a></li>
<li><a href="http://ci.codehaus.org/browse/PROXYTOYS">Build Status</a></li>
<li><a href="https://www.openhub.net/p/10075">Code Statistics</a></li>
</ul>
</div>
</div>
</body>
</html>