Difference between revisions of "HowTo:Contribute"

From Open Babel
Jump to: navigation, search
(Added links)
Line 1: Line 1:
There are many ways to contribute to Open Babel -- it's a community effort. The project has benefitted significantly from contributions (some small, some large) from many users. Like many open source projects, Open Babel needs contributions of all sorts, not just development of C++ code.
+
There are many ways to contribute to Open Babel -- it's a [http://openbabel.sourceforge.net/THANKS.shtml community effort]. The project has benefitted significantly from contributions (some small, some large) from many users. Like many open source projects, Open Babel needs contributions of all sorts, not just development of C++ code.
  
If you'd like to contribute in some way, here are some suggestions, although other ideas are more than welcome.
+
If you'd like to contribute in some way, here are some suggestions, although other ideas are '''more''' than welcome.
  
==Possible Non-Coding Contributions==
+
== Possible Non-Coding Contributions ==
  
 
* Help improve the documentation or website.
 
* Help improve the documentation or website.
* Include references to Open Babel in research talks or publications.
+
* Include references to Open Babel in [http://openbabel.sourceforge.net/citations.shtml research talks or publications].
 
* Help with internationalization: translate to Open Babel's messages and errors to a foreign language.
 
* Help with internationalization: translate to Open Babel's messages and errors to a foreign language.
* Supply example files for various formats to the test repository.
+
* Supply example files for various formats to the [http://openbabel.sourceforge.net/repository.shtml test repository].
 
* Contact your proprietary software vendors and suggest they contribute to Open Babel or standardize and publish their file format specifications for use by other programs.
 
* Contact your proprietary software vendors and suggest they contribute to Open Babel or standardize and publish their file format specifications for use by other programs.
 
* Help compile data, e.g. for molecular fingerprints and rotatable bonds.
 
* Help compile data, e.g. for molecular fingerprints and rotatable bonds.
* Suggest a needed feature.
+
* Suggest a [http://sourceforge.net/tracker/?atid=428743&group_id=40728&func=browse needed feature].
* Suggest a needed file format.
+
* Suggest a [http://sourceforge.net/tracker/?atid=447448&group_id=40728&func=browse needed file format].
  
==Possible Code Contributions==
+
== Possible Code Contributions ==
  
* Fix a bug.
+
* Fix a [http://sourceforge.net/tracker/?atid=428740&group_id=40728&func=browse bug].
* Add a new file format.
+
* Add a [http://openbabel.sourceforge.net/howto-add-a-format.shtml new file format].
 
* Write a GUI for Linux like the current versions on Windows or iBabel for Mac OS X.
 
* Write a GUI for Linux like the current versions on Windows or iBabel for Mac OS X.
* Integrate Open Babel into another program.
+
* Integrate Open Babel into another [http://openbabel.sourceforge.net/links.shtml program].
* Write Perl or Python scripts using the Open Babel "wrapper" support for these languages.
+
* Write [http://openbabel.sourceforge.net/perldoc.shtml Perl] or [http://openbabel.sourceforge.net/pythondoc.shtml Python] scripts using the Open Babel "wrapper" support for these languages.
 
* Port and integrate code contributed for point-group and space group symmetry perception.
 
* Port and integrate code contributed for point-group and space group symmetry perception.
 
* Contribute a molecular mechanics force field to assist with coordinate generation and rotamer / conformer evaluation.
 
* Contribute a molecular mechanics force field to assist with coordinate generation and rotamer / conformer evaluation.
 
* Enhance "lazy perception" by adding subclasses to OBMol.
 
* Enhance "lazy perception" by adding subclasses to OBMol.
* Add a requested feature from the tracker.
+
* Add a requested feature from the [http://sourceforge.net/tracker/?atid=428743&group_id=40728&func=browse tracker].
* Add support for additional data type translation and perception.
+
* Add support for additional [http://sourceforge.net/tracker/?atid=451585&group_id=40728&func=browse data type translation and perception].
* Contribute an item off of the potential roadmap.  
+
* Contribute an item off of the [http://openbabel.sourceforge.net/roadmap.shtml potential roadmap].
  
In short, we're just getting started. There's still [[Roadmap |plenty to do]. Contact the [mailto:[email protected] openbabel-discuss mailing list] for more questions, comments, suggestions, etc.
+
In short, we're just getting started. There's still plenty to do. Contact the [mailto:[email protected] openbabel-discuss mailing list] for more questions, comments, suggestions, etc.

Revision as of 14:37, 5 December 2005

There are many ways to contribute to Open Babel -- it's a community effort. The project has benefitted significantly from contributions (some small, some large) from many users. Like many open source projects, Open Babel needs contributions of all sorts, not just development of C++ code.

If you'd like to contribute in some way, here are some suggestions, although other ideas are more than welcome.

Possible Non-Coding Contributions

  • Help improve the documentation or website.
  • Include references to Open Babel in research talks or publications.
  • Help with internationalization: translate to Open Babel's messages and errors to a foreign language.
  • Supply example files for various formats to the test repository.
  • Contact your proprietary software vendors and suggest they contribute to Open Babel or standardize and publish their file format specifications for use by other programs.
  • Help compile data, e.g. for molecular fingerprints and rotatable bonds.
  • Suggest a needed feature.
  • Suggest a needed file format.

Possible Code Contributions

  • Fix a bug.
  • Add a new file format.
  • Write a GUI for Linux like the current versions on Windows or iBabel for Mac OS X.
  • Integrate Open Babel into another program.
  • Write Perl or Python scripts using the Open Babel "wrapper" support for these languages.
  • Port and integrate code contributed for point-group and space group symmetry perception.
  • Contribute a molecular mechanics force field to assist with coordinate generation and rotamer / conformer evaluation.
  • Enhance "lazy perception" by adding subclasses to OBMol.
  • Add a requested feature from the tracker.
  • Add support for additional data type translation and perception.
  • Contribute an item off of the potential roadmap.

In short, we're just getting started. There's still plenty to do. Contact the openbabel-discuss mailing list for more questions, comments, suggestions, etc.