Difference between revisions of "Help"

From Open Babel
Jump to: navigation, search
m (More info)
Line 1: Line 1:
 
Having problems using OpenBabel? It didn't work or it didn't do what you expected?
 
Having problems using OpenBabel? It didn't work or it didn't do what you expected?
  
You've come to the right place. Here we explain how to let us know about a problem. This will help us to make Open Babel better for everyone.
+
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 ===
 
=== How to ask for help ===
  
...mailing list...remember to click "Reply all" if someone replies
+
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].
 +
 
 +
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 ===
 
=== How to report a bug ===
Line 15: Line 17:
 
# Fill in the boxes to describe your bug report...
 
# Fill in the boxes to describe your bug report...
  
A good bug report will 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* (if you have logged in using a SourceForge account it is not necessary to include your email address)
 
* What version of Open Babel are you using, and on what platform?
 
* What version of Open Babel are you using, and on what platform?
 
* An attachment containing an example input file that causes problem
 
* An attachment containing an example input file that causes problem
* Don't just say, "it doesn't work" or "the output file had the wrong atom type". Explain giving an example of what exactly didn't work.
+
* 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.
  
 
Here is an example of a poor bug report:
 
Here is an example of a poor bug report:
 
* [http://sourceforge.net/tracker/index.php?func=detail&aid=1670344&group_id=40728&atid=428740 Bug 1670344 Segault with a large PDB file] We couldn't reproduce the problem as no example file was provided, nor were any contact details included.
 
* [http://sourceforge.net/tracker/index.php?func=detail&aid=1670344&group_id=40728&atid=428740 Bug 1670344 Segault with a large PDB file] We couldn't reproduce the problem as no example file was provided, nor were any contact details included.
 +
 +
===Suggestions?===
 +
 +
[[Contribute|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:
 +
* 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=451585 data types]]

Revision as of 16:41, 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.

How to 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.

How to report a bug

  1. Go to the Open Babel bug tracker at http://sourceforge.net/tracker/?group_id=40728&atid=428740
  2. 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).
  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* (if you have logged in using a SourceForge account it is not necessary to include your email address)
  • What version of Open Babel are you using, and on what platform?
  • An attachment containing an example input file that causes 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.

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: