How to Contribute: Difference between revisions

From JogampWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
'''Easiest way to contribute:'''
= Easy to contribute =
 
== Overview ==
 
Our modules have been [http://blog.jausoft.com/2009/07/08/svn-to-git-migration-1/ migrated to git],
thanks to the great git toolchain.<br>
In the past we were using a centralized repository only, ''SVN'',
and you really needed access to a central repository.
 
Chose a media to offer your branch to the [[Maintainer and Contacts#Maintainer|module maintainer]].
This may be via
* [http://www.kernel.org/pub/software/scm/git/docs/everyday.html#Individual%20Developer%20%28Participant%29 email]
* [http://weblog.masukomi.org/wp-content/uploads/2008/03/config_remote_repo.svg http]
* [http://kernel.org/pub/software/scm/git/docs/howto/use-git-daemon.txt git]
 
Surely it's most easy for us to access your git repository via the git protocol
you may host on a free git server like [[http://github.com github]].
 
Just '''create a branch of your own and make it available''', then you may ask
the [[Maintainer and Contacts#Maintainer|module maintainer]] to pull, review and merge your branch.<br>
[http://whygitisbetterthanx.com/#any-workflow Collaboration] using a [http://whygitisbetterthanx.com/#distributed distributed SCM] is easy.
 
== Steps ==
 
* fork a [[Jogamp SCM Repositories|SCM repository]]
* fork a [[Jogamp SCM Repositories|SCM repository]]
* do what ever you want with it, obeying its license.
* do with it as you please while obeying the modules license and <i>the law</i>.
* tell us about the earth shaking improvements you made via the [http://jogamp.org/forum.html mailinglists/forum]
* tell us about the earth shaking improvements you made via the [http://jogamp.org/forum.html mailinglists/forum] and contact the [[Maintainer and Contacts#Maintainer|module maintainer]]
* if everything works fine we will probably integrate it very soon
* if everything works fine we will probably integrate it soon, <b>if</b>
 
** you include a [http://jogamp.org/git/?p=jogl.git;a=blob;f=src/junit/com/jogamp/test/junit/newt/TestGLWindows00NEWT.java <b>a junit test</b>] reflecting your changes / feature
'''important:'''
** you comply the the modules license and contribute under it's terms
''please make sure you commit with your '''full name''' and a '''valid email address'''. Once your changes are integrated, it is very difficult to fix those things afterwards. (see [http://help.github.com/git-email-settings/ howto])''
** we can <i>somehow</i> verify your identity, at least you use your <b>full name</b> in your [http://help.github.com/git-email-settings/ git commits]


----


'''building the projects'''
To actually build the beast, please refer to the following manuals:
* put all projects you are interested in into one folder (otherwise the dependencies won't be resolved automatically)
* [{{SERVER}}/jogl/doc/HowToBuild.html How To Build JOGL]
* jogl, jocl, joal depends on gluegen
* [{{SERVER}}/jocl/doc/HowToBuild.html How To Build JOCL]
* jocl depends on jogl
* foo-demos depends on foo
'''build HowTo links'''
* http://jogamp.org/jogl/doc/HowToBuild.html
* http://jogamp.org/jocl/doc/HowToBuild.html


----


'''if you are new to GIT take a look at those pages:'''
== Git References ==
* http://help.github.com/git-installation-redirect
* http://help.github.com/git-installation-redirect
* http://help.github.com/git-email-settings/
* http://help.github.com/git-email-settings/
'''or general git help index:'''
* http://help.github.com/
* http://help.github.com/
 
* [http://git.or.cz/course/svn.html GIT Manual for SVN Experts]
'''for SVN experts which want to learn git:'''
* http://git.or.cz/course/svn.html

Revision as of 00:28, 26 November 2010

Easy to contribute

Overview

Our modules have been migrated to git, thanks to the great git toolchain.
In the past we were using a centralized repository only, SVN, and you really needed access to a central repository.

Chose a media to offer your branch to the module maintainer. This may be via

Surely it's most easy for us to access your git repository via the git protocol you may host on a free git server like [github].

Just create a branch of your own and make it available, then you may ask the module maintainer to pull, review and merge your branch.
Collaboration using a distributed SCM is easy.

Steps

  • fork a SCM repository
  • do with it as you please while obeying the modules license and the law.
  • tell us about the earth shaking improvements you made via the mailinglists/forum and contact the module maintainer
  • if everything works fine we will probably integrate it soon, if
    • you include a a junit test reflecting your changes / feature
    • you comply the the modules license and contribute under it's terms
    • we can somehow verify your identity, at least you use your full name in your git commits


To actually build the beast, please refer to the following manuals:


Git References

Retrieved from "https://jogamp.org/wiki/index.php?title=How_to_Contribute&oldid=263"