-
Notifications
You must be signed in to change notification settings - Fork 0
javaRuntype web site
License
javaruntype/javaruntype.github.com
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <!-- Generated by Apache Maven Doxia Site Renderer 1.3 at Nov 17, 2016 --> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <title>javaRuntype: runtime type system for Java - Contributing to javaRuntype</title> <style type="text/css" media="all"> @import url("./css/maven-base.css"); @import url("./css/maven-theme.css"); @import url("./css/site.css"); </style> <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> <meta name="Date-Revision-yyyymmdd" content="20161117" /> <meta http-equiv="Content-Language" content="en" /> </head> <body class="composite"> <div id="banner"> <a href="./" id="bannerLeft"> <img src="images/javaruntype_logo.png" alt="javaRuntype: runtime type system for Java" /> </a> <div class="clear"> <hr/> </div> </div> <div id="breadcrumbs"> <div class="xleft"> <span id="publishDate">Last Published: 17 Nov 2016</span> | <span id="projectVersion">Version: 1.3</span> </div> <div class="xright"> <a href="index.html" title="Main">Main</a> | <a href="download.html" title="Download">Download</a> | <a href="apidocs/index.html" title="Javadoc">Javadoc</a> | <a href="https://github.com/javaruntype/javaruntype" class="externalLink" title="Github Repository">Github Repository</a> </div> <div class="clear"> <hr/> </div> </div> <div id="leftColumn"> <div id="navcolumn"> <h5>The javaRuntype Project</h5> <ul> <li class="none"> <a href="index.html" title="· Main">· Main</a> </li> <li class="none"> <a href="download.html" title="· Download">· Download</a> </li> <li class="none"> <a href="maveninfo.html" title="· Maven Info">· Maven Info</a> </li> <li class="none"> <a href="dependencies.html" title="· Dependencies">· Dependencies</a> </li> <li class="expanded"> <a href="#" title="· Documentation">· Documentation</a> <ul> <li class="none"> <a href="types.html" title="· Using Types">· Using Types</a> </li> <li class="none"> <a href="apidocs/index.html" title="· Javadoc">· Javadoc</a> </li> <li class="none"> <a href="faq.html" title="· FAQ">· FAQ</a> </li> </ul> </li> <li class="none"> <a href="https://github.com/javaruntype/javaruntype" class="externalLink" title="· Github Repository">· Github Repository</a> </li> <li class="none"> <a href="license.html" title="· License">· License</a> </li> <li class="none"> <a href="team.html" title="· Team">· Team</a> </li> </ul> <a href="https://maven.apache.org" title="Built with Maven 2" class="poweredBy"> <img class="poweredBy" alt="Built with Maven 2" src="images/logos/maven-feather.png" /> </a> </div> </div> <div id="bodyColumn"> <div id="contentBox"> <div class="section"><h2>Contributing to javaRuntype: Terms<a name="Contributing_to_javaRuntype:_Terms"></a></h2><p>In order to contribute to javaRuntype, there are some terms with which you must agree:</p><p><b>Who can contribute?:</b></p><ul><li>Anyone, with the unique condition that he/she must be a <b>private individual</b>, acting in his/her own name, and not being endorsed in their contributed work by any company or government.</li></ul><ul><li>Note that this condition will not only refer to the ownership of the effort invested in contributing to the project, but also to the fact that no private or public company will be mentioned as a a part of your contribution on the project's website or code, including but not limited to email addresses or package names.</li></ul><p><b>About your contributed code:</b></p><ul><li>First and important: your code <b>must both compile and work correctly</b>. Also, the addition of any new patches to the codebase should not render it unstable in any way.</li></ul><ul><li>There should be no compilation warnings.</li></ul><ul><li>All your code should follow the Java Code Conventions. The only exception for this is that column limit is 120 instead of the usual 80 characters (this is a matter of convenience). </li></ul><ul><li>Remember that indentation is made of four spaces, not tabs.</li></ul><ul><li>All your code should compile and run in Java 1.4, and it should be easy to read and understand by a human.</li></ul><ul><li>All public methods and classes should have comprehensive javadoc, and code should have a reasonable amount of comments in it (when needed, of course, not just comment for comment).</li></ul><ul><li>All comments, names of classes and variables, log messages, etc. must be in <b>English</b>.</li></ul><p><b>About your relation to the javaRuntype project:</b></p><ul><li>First and most important: please, don't feel any obligation to do anything. If you like/want/feel happy about contributing, go for it. If not, don't feel any kind of commitment just for having discussed technical details with the project maintainers or other members, just leave it behind and it will be absolutely fine, even if it is after months and you have already coded thousands of lines.</li></ul><ul><li>You will be <tt>@author</tt> for any new classes that you code and also co-author to any existing classes to which you make <i>significant</i> changes. Of course you can say "no" to this, but unless you do, it is a matter of basic fairness to give the credit and merit to the person who deserves it.</li></ul><ul><li>Your contributions will be applied as patches that you will send to the project maintainers, and you will have the consideration of <i>contributor</i> in the team page. This means that you will not have read+write direct access to the CVS repository. This is something reserved for developers who are author to a very significant percent of the total code base. Of course, this consideration can change in the future.</li></ul><ul><li>And importantly: You will have to take the required measures, under your entire responsibility, to <b>ensure that the company/ies you work for will never claim any rights over your contributed code</b>, and that all the code you contribute is original and will rise no claims over its intellectual property by any third persons or companies. Also, you agree to contribute your code or documentation <b>for free and under the terms established by the Apache License 2.0 in a time-unlimited basis</b>.</li></ul></div><div class="section"><h2>Contributing to javaRuntype: Steps<a name="Contributing_to_javaRuntype:_Steps"></a></h2><p>If, after carefully reading the above terms, you are willing to contribute some of your effort to javaRuntype, first of all... THANK YOU! </p><p>The steps you should take are:</p><ul><li>1. First, send an email to the project maintainers talking about the new features or fixes you would like to contribute. Don't forget to include your full name :-).</li></ul><ul><li>2. If your contribution is approved, send the project maintainers an email including a copy of the terms above, with your complete name, and stating clearly that you agree with these conditions.</li></ul><ul><li>3. If you work for a company which, by the way or place in which your code was written, by your contract terms or by the laws in your contry, could claim any rights (including intellectual property) over your contributed code, you will have to send the project maintainers (either by email from your authorised superiors or by signed fax), a statement indicating that your company agrees with the terms explained in this page, and that it both authorises your contribution to javaRuntype and states that will never claim any kind of rights over it.</li></ul></div> </div> </div> <div class="clear"> <hr/> </div> <div id="footer"> <div class="xright"> Copyright © 2016 <a href="https://www.javaruntype.org">The JAVARUNTYPE team</a>. All Rights Reserved. </div> <div class="clear"> <hr/> </div> </div> </body> </html>
About
javaRuntype web site
License
Contributing
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published