/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/how-to-contribute.html
HTML | 164 lines | 128 code | 24 blank | 12 comment | 0 complexity | c231c4da9e84b2ec8a8c910d382ddc6a MD5 | raw file
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<!-- 4 Copyright (C) 2005, 2006 Joe Walnes. 5 Copyright (C) 2006, 2007, 2008 XStream committers. 6 All rights reserved. 7 8 The software in this package is published under the terms of the BSD 9 style license a copy of which has been included with this distribution in 10 the LICENSE.txt file. 11 12 Created on 29. January 2005 by Joe Walnes 13 --> 14 <head> 15 <title>XStream - How to Contribute</title> 16 <link rel="stylesheet" type="text/css" href="style.css"/> 17 18 19 20 21 <!-- Google analytics --> 22 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"> 23 </script> 24 <script type="text/javascript"> 25 _uacct = "UA-110973-2"; 26 urchinTracker(); 27 </script> 28 29 </head> 30 <body> 31 32 <div id="banner"> 33 <a href="index.html"><img id="logo" src="logo.gif" alt="XStream"/></a> 34 </div> 35 36 <div id="center" class="Content2Column"> <!-- Content3Column for index --> 37 <div id="content"> 38 <h1 class="FirstChild">How to Contribute</h1> 39 40 41 42 <p>XStream is nothing without contributions from the user community. There are many ways to 43 contribute. We are constantly working on the software and documentation, so it's a good 44 idea to contact the team on the 45 <a href="list-user.html">user</a> or <a href="list-dev.html">development</a> mailing lists 46 to avoid duplicating effort.</p> 47 48 <h2 id="documentation">Documentation</h2> 49 <p>One of the traditional weak points of open source software is the documentation. Any 50 help with this aspect of the project will be welcomed with open arms, or at the very least 51 with open email clients!</p> 52 53 <h2 id="examples">Examples</h2> 54 <p>We are working on one or two examples of using XStream, but we can always do with more.</p> 55 56 <h2 id="feature-requests">Feature Requests</h2> 57 <p>We eat our own dogfood, but we're also happy to feed other people's dogs (if you'll excuse 58 a stretched <s>dachshund</s> metaphor!). If you want to request a new feature you can either 59 make a request through the <a href="http://jira.codehaus.org/browse/XSTR">issue tracker</a> or by sending a message to the 60 <a href="list-dev.html">development mailing list</a>. The benefit of any new features 61 will be discussed on the mailing list, so its a good idea to sign up so that you can stick your oar in.</p> 62 63 <h2 id="bug-reports">Bug Reports</h2> 64 <p>You can report bugs through the <a href="http://jira.codehaus.org/browse/XSTR">issue tracker</a> interface or the 65 <a href="list-dev.html">development mailing list</a>. Additional brownie 66 points are awarded for bug reports that include a failing unit test.</p> 67 68 <h2 id="patches">Bug Fixes</h2> 69 <p>If you want <em>lots</em> of brownie points, send a fix along with your bug report 70 and failing unit test. Bug fixes are best sent as patches that we can apply to the 71 codebase. Remember to tell us which version the patch should be applied against, or 72 we'll get very confused. To be accepted into the codebase, patches must be released 73 under the <a href="license.html">same license as XStream itself</a>.</p> 74 75 <h2 id="new-code">New Code</h2> 76 <p>If you have a new feature request, then we'll listen extra hard if you show us how it 77 works. A new feature might be best implemented as a patch to an existing class 78 or as a new class. The XStream API contains many extension points that allow new functionality 79 to be integrated into the framework. We are rather anal about testing, so if you send us 80 some code without any tests we will probably ask you to write the tests tests as well 81 before we add it to the codebase.</p> 82 83 <h2 id="your-own-extension">Write Your Own XStream Extension</h2> 84 <p>If you have a project that builds upon XStream we will be happy to announce your 85 project on the XStream site.</p> 86 87 <h2 id="become-committer">Become a Committer</h2> 88 <p>We follow the <a href="http://www.codehaus.org/Manifesto">Codehaus manifesto</a> 89 when it comes to expanding the core team.</p> 90 91 92 93 <br/> 94 95 </div> 96 </div> 97 98 <div class="SidePanel" id="left"> 99 <div class="MenuGroup"> 100 <h1>Software</h1> 101 <ul> 102 <li><a href="index.html">About XStream</a></li> 103 <li><a href="news.html">News</a></li> 104 <li><a href="changes.html">Change History</a></li> 105 <li><a href="versioning.html">About Versioning</a></li> 106 </ul> 107 </div> 108 <div class="MenuGroup"> 109 <h1>Evaluating XStream</h1> 110 <ul> 111 <li><a href="tutorial.html">Two Minute Tutorial</a></li> 112 <li><a href="graphs.html">Object references</a></li> 113 <li><a href="manual-tweaking-output.html">Tweaking the Output</a></li> 114 <li><a href="license.html">License</a></li> 115 <li><a href="download.html">Download</a></li> 116 <li><a href="references.html">References</a></li> 117 <li><a href="parser-benchmarks.html">Parser Benchmarks</a></li> 118 <li><a href="http://www.ohloh.net/projects/3459">Code Statistics</a></li> 119 </ul> 120 </div> 121 <div class="MenuGroup"> 122 <h1>Using XStream</h1> 123 <ul> 124 <li><a href="architecture.html">Architecture Overview</a></li> 125 <li><a href="converters.html">Converters</a></li> 126 <li><a href="faq.html">Frequently Asked Questions</a></li> 127 <li><a href="list-user.html">Users' Mailing List</a></li> 128 <li><a href="issues.html">Reporting Issues</a></li> 129 </ul> 130 </div> 131 <div class="MenuGroup"> 132 <h1>Javadoc</h1> 133 <ul> 134 <li><a href="javadoc/index.html">XStream Core</a></li> 135 <li><a href="hibernate-javadoc/index.html">Hibernate Extensions</a></li> 136 <li><a href="benchmark-javadoc/index.html">Benchmark Module</a></li> 137 </ul> 138 </div> 139 <div class="MenuGroup"> 140 <h1>Tutorials</h1> 141 <ul> 142 <li><a href="tutorial.html">Two Minute Tutorial</a></li> 143 <li><a href="alias-tutorial.html">Alias Tutorial</a></li> 144 <li><a href="annotations-tutorial.html">Annotations Tutorial</a></li> 145 <li><a href="converter-tutorial.html">Converter Tutorial</a></li> 146 <li><a href="objectstream.html">Object Streams Tutorial</a></li> 147 <li><a href="persistence-tutorial.html">Persistence API Tutorial</a></li> 148 <li><a href="json-tutorial.html">JSON Tutorial</a></li> 149 </ul> 150 </div> 151 <div class="MenuGroup"> 152 <h1>Developing XStream</h1> 153 <ul> 154 <li class="currentLink">How to Contribute</li> 155 <li><a href="list-dev.html">Developers' Mailing List</a></li> 156 <li><a href="team.html">Development Team</a></li> 157 <li><a href="repository.html">Source Repository</a></li> 158 <li><a href="http://bamboo.ci.codehaus.org/browse/XSTREAM">Continuous Integration</a></li> 159 </ul> 160 </div> 161 </div> 162 163 </body> 164</html>