Difference between revisions of "How to contribute"

From Eigen
Redirect page
Jump to: navigation, search
m (link to "Contributing to Eigen")
(replace by #REDIRECT Contributing to Eigen)
 
Line 1: Line 1:
[[Category:Developer]]
+
#REDIRECT [[Contributing to Eigen]]
 
+
Note: Most content of this page has been moved to [[Contributing to Eigen]]. Please go there first.
+
 
+
----
+
 
+
 
+
Following a [http://comments.gmane.org/gmane.comp.lib.eigen/4528 mailing list discussion] on how to reduce our open bugs and improve the maintenance of Eigen, this page intends to instruct volunteers on how they can contribute to Eigen.
+
 
+
If you are willing to contribute, add yourself [[#Volunteers|at the end of this page]]!
+
 
+
This page is work-in-progress. Feel free to edit!
+
 
+
== Tasks ==
+
There are many tasks which require different levels and areas of expertise
+
 
+
* Documentation
+
** If you find undocumented or poorly or even wrongly documented functions or classes, [[Bugzilla#Reporting_a_bug|report them]]. If you feel able then [[Mercurial|send us patches]] to improve the documentation.
+
* Support
+
** Answer user questions on our [[Main_Page#Get_support|support channels]].
+
** Try to improve our [[FAQ]] with questions that arise frequently.
+
* Unit testing
+
** If you have some CPU hours to spare you can make nightly runs of our [[Tests|unit-testsuite]]. This would be especially helpful for rarely tested compilers.
+
* Bugs
+
** [[Bugzilla#Reporting_a_bug|report them]] and [[Mercurial|send us patches]]
+
** Also try [[Tests#Writing_unit_tests|adding unit tests]]
+
** We need people especially for rarely used compilers/platforms
+
* Build system
+
** If you have experience with [[CMake]] you can help improving detection of available libraries or simplify the building process, of
+
* Take part in API discussions
+
** From time to time there are discussions on the mailing list or in bugzilla about new features or change requests in the current API. It helps to get feedback from many users on what kind of API they expect. This does not require being able to implement those changes!
+
* Add other things to this list
+
 
+
== Suggestions on how to work off the current bug list ==
+
As of June 2014 there are [http://eigen.tuxfamily.org/bz/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=DECISIONNEEDED&bug_status=REOPENED&order=bug_id more than 300 open bugs]! We need to work them off, eventually.
+
We found several things that could help us doing so.
+
 
+
* TODO: Write this list -- until then read the mailing list discussion linked above.
+
 
+
 
+
== Volunteers ==
+
 
+
This section is to collect people who would like to regularly contribute to Eigen.
+
If you intend to regularly contribute to Eigen, add yourself to this table.
+
Add areas of interest, expertise, or anything else in the second column. This could be structured better in the future.
+
 
+
If you don't have write access to this wiki, ask an [http://eigen.tuxfamily.org/index.php?title=Special:ListUsers&group=sysop administrator].
+
 
+
{| class="wikitable" border="1"  cellpadding="4"
+
!Name
+
!Interests
+
|-
+
| Christoph Hertzberg
+
| API and Architecture Discussions, Reviewing patches, ...
+
|-
+
|}
+

Latest revision as of 16:19, 11 June 2014