Difference between revisions of "Contributing"

From BoofCV
Jump to navigationJump to search
m
m
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Ways to Contribute =
BoofCV is an open source project and in order for it to grow its users need contribute to the project!  Even if you don't know computer vision or how to program there are many ways you can contribute.


# Report bugs!
== Report Bugs! ==
# Spread the word!
 
#* Social Media (e.g. blogs, twitter, facebook, linkedin)
Seriously, if you find a bug please report it!  Make sure you read the documentation first though. Sometimes its useful to report a but even if there isn't really one. That can be an indication that the documentation in that area needs improvement.
#* Write articles demonstrating how to do stuff in BoofCV (e.g. Code Project)
 
#* Positive Reviews (e.g. Play Store, Source Forge)
== Source Code ==
# Submit fixes on Github for code and javadoc errors
 
# BoofCV interface for [http://www.processing.org/ Processing]
Got something you think might be useful in BoofCV? Well let us know!  You should post it online to make it easy to inspect and provide one or more examples. It's ok if the code is not perfect.
# Android
 
#* Point cloud viewer for [https://play.google.com/store/apps/details?id=org.boofcv.android demonstration application]
To actually make it into BoofCV the code will need rigorous unit tests and be programmed in a certain way to make it more efficient.  The good news is that those can be done afterwards. We will do our best to your code conform and might even modify it ourselves, depending on time and need.  All code which is contributed into BoofCV will need to be transferred to the standard BoofCV license, but your contribution will be acknowledged!
#* Any sort of cool demonstration
 
# Clean up its Maven build
If for some reason your code doesn't make it in we will still advertise it if it looks like a useful feature, but is out of scope or just not ready yet.
#* Currently requires a password for each module when pushed to central.
 
#* No BoofCV will not become an entirely Maven project to make Maven easier
== Social Media ==
# [http://jcodec.org/ JCodec]
 
#* Get it working and start converting movies into standard formats, when appropriate
We are actively trying to grow the BoofCV community and need help spreading the word.  YouTube videos, blog posts, articles, or papers are good ways to do this.  Also participating on the message boards and answering questions is a good idea too.
# [http://xstream.codehaus.org/ XStream]
#* Verify that latest version works in applets
#* Update code for changes
# Take a look at [http://code.google.com/p/aparapi/ Aparapi] to see if using a GPU can speed up any of the code.
# Continuous integration using [https://www.atlassian.com/software/bamboo Bamboo]
# [[Validation:Algorithms |Validate the correctness of algorithms]]
# Sparse Bundle Adjustment
# Image segmentation
#* Watershed
#* <strike>Mean-Shift</strike>
#* [http://www.cs.toronto.edu/~babalex/09.pami.turbopixels.pdf Turbo Pixels]
# [https://en.wikipedia.org/wiki/Background_subtraction Background Subtraction]
# Clean up the Wiki
# Wavelets
## Arbitrary length Coiflet coefficients
## Arbitrary length Daub coefficients
## Verify that Biorthogonal Daub is buggy and fix
## Don't add any addition jar file requires for wavelet tasks
# Suggesting ways to improve the API.
# Runtime regression tests

Latest revision as of 05:25, 21 September 2015

Report Bugs!

Seriously, if you find a bug please report it! Make sure you read the documentation first though. Sometimes its useful to report a but even if there isn't really one. That can be an indication that the documentation in that area needs improvement.

Source Code

Got something you think might be useful in BoofCV? Well let us know! You should post it online to make it easy to inspect and provide one or more examples. It's ok if the code is not perfect.

To actually make it into BoofCV the code will need rigorous unit tests and be programmed in a certain way to make it more efficient. The good news is that those can be done afterwards. We will do our best to your code conform and might even modify it ourselves, depending on time and need. All code which is contributed into BoofCV will need to be transferred to the standard BoofCV license, but your contribution will be acknowledged!

If for some reason your code doesn't make it in we will still advertise it if it looks like a useful feature, but is out of scope or just not ready yet.

Social Media

We are actively trying to grow the BoofCV community and need help spreading the word. YouTube videos, blog posts, articles, or papers are good ways to do this. Also participating on the message boards and answering questions is a good idea too.

Retrieved from "http://boofcv.org/index.php?title=Contributing&oldid=1642"