Difference between revisions of "Help"

From Open Babel
Jump to: navigation, search
Line 3: Line 3:
 
Sorry about that, but you've come to the right place. Here you can find some suggestions on finding help.
 
Sorry about that, but you've come to the right place. Here you can find some suggestions on finding help.
  
=== How to ask for help ===
+
=== Ask for Help ===
  
 
A good place to go for general help is the [http://sourceforge.net/mailarchive/forum.php?forum_name=openbabel-discuss openbabel-discuss] mailing list. List information can be found [http://lists.sourceforge.net/mailman/listinfo/openbabel-discuss here].
 
A good place to go for general help is the [http://sourceforge.net/mailarchive/forum.php?forum_name=openbabel-discuss openbabel-discuss] mailing list. List information can be found [http://lists.sourceforge.net/mailman/listinfo/openbabel-discuss here].
Line 9: Line 9:
 
This mailing list is for general discussion and support, so please feel free to [mailto:[email protected] e-mail] any question or concern.
 
This mailing list is for general discussion and support, so please feel free to [mailto:[email protected] e-mail] any question or concern.
  
=== How to report a bug ===
+
=== Report a Bug ===
  
# Go to the Open Babel bug tracker at http://sourceforge.net/tracker/?group_id=40728&atid=428740
+
We strive to ensure Open Babel is as bug-free as possible. Please hold us to that -- let us know if it does something incorrect! By reporting bugs, you can track our progress in fixing it, and ensure we follow up on your problem.
# A SourceForge account is not necessary but it's a really good idea (you will be updated if we fix the bug or if we ask for further information). If you have one already, please log in (click on "Log in" in the top right). If you don't have one, you can either create one (click on "Create account"), or just simply continue to step (3).
+
 
 +
# Go to the Open Babel [http://sourceforge.net/tracker/?group_id=40728&atid=428740 bug tracker]
 +
# If you have a SourceForge account, please log in, or consider signing up (it's free)
 
# To submit a new bug, click on "Submit new"
 
# To submit a new bug, click on "Submit new"
 
# Please read the instructions under "Sorry you're having trouble!"
 
# Please read the instructions under "Sorry you're having trouble!"
Line 18: Line 20:
  
 
A good bug report should include:
 
A good bug report should include:
* Your *name* and *email address* (if you have logged in using a SourceForge account it is not necessary to include your email address)
+
* Your '''name''' and '''email address'''
* What version of Open Babel are you using, and on what platform?
+
* The version of Open Babel are you using, and your operating system (Linux, Mac OS X, Windows, Solaris, etc.)
* An attachment containing an example input file that causes problem
+
* An attachment containing an example input file that causes the problem.
* Don't just say, "it doesn't work" or "the output file had the wrong atom type". Please try to be more specific and give an example of what exactly didn't work. Please let us know what you think should have happened instead.
+
* Please try to be specific and give an example of what exactly didn't work. Please let us know what you think should have happened instead.
  
 
Here is an example of a poor bug report:
 
Here is an example of a poor bug report:
Line 31: Line 33:
  
 
Please feel free to suggest:
 
Please feel free to suggest:
* New [[http://sourceforge.net/tracker/?group_id=40728&atid=428743 features]]
+
* New [http://sourceforge.net/tracker/?group_id=40728&atid=428743 features]
* New [[http://sourceforge.net/tracker/?group_id=40728&atid=447448 file formats]]
+
* New [http://sourceforge.net/tracker/?group_id=40728&atid=447448 file formats]
* New [[http://sourceforge.net/tracker/?group_id=40728&atid=451585 data types]]
+
* New [http://sourceforge.net/tracker/?group_id=40728&atid=451585 data types]

Revision as of 17:46, 7 April 2007

Having problems using OpenBabel? It didn't work or it didn't do what you expected?

Sorry about that, but you've come to the right place. Here you can find some suggestions on finding help.

Ask for Help

A good place to go for general help is the openbabel-discuss mailing list. List information can be found here.

This mailing list is for general discussion and support, so please feel free to e-mail any question or concern.

Report a Bug

We strive to ensure Open Babel is as bug-free as possible. Please hold us to that -- let us know if it does something incorrect! By reporting bugs, you can track our progress in fixing it, and ensure we follow up on your problem.

  1. Go to the Open Babel bug tracker
  2. If you have a SourceForge account, please log in, or consider signing up (it's free)
  3. To submit a new bug, click on "Submit new"
  4. Please read the instructions under "Sorry you're having trouble!"
  5. Fill in the boxes to describe your bug report...

A good bug report should include:

  • Your name and email address
  • The version of Open Babel are you using, and your operating system (Linux, Mac OS X, Windows, Solaris, etc.)
  • An attachment containing an example input file that causes the problem.
  • Please try to be specific and give an example of what exactly didn't work. Please let us know what you think should have happened instead.

Here is an example of a poor bug report:

Suggestions?

Contributions of all sorts are most welcome. Open Babel is a community project and would not be the same without your feedback and suggestions.

Please feel free to suggest: