Difference between revisions of "Help"

From Open Babel
Jump to: navigation, search
m (Typo)
m (Update bug reporting info)
 
(5 intermediate revisions by 2 users not shown)
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 report a bug ===
+
=== Ask for Help ===
  
# Go to the Open Babel bug tracker at http://sourceforge.net/tracker/?group_id=40728&atid=428740
+
A good place to go for general help is the <b>openbabel-discuss</b> mailing list. We encourage you to subscribe to the list [http://lists.sourceforge.net/mailman/listinfo/openbabel-discuss here], and then send your query to <b>[email protected].sf.net</b>.
# 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).
+
# To submit a new bug, click on "Submit new"
+
# Please read the instructions under "Sorry you're having trouble!"
+
# Fill in the boxes to describe your bug report...
+
  
A good bug report will include:
+
You can also email the list without subscribing, but your email will not appear for up to a week (emails are moderated on Tuesday mornings).
* 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". Explain giving an example of what exactly didn't work.
+
  
Here are some poor bug reports that we weren't able to fix, because we never found out what was wrong and the authors didn't give us any contact details:
+
An archive of posts to the list can be accessed [http://sourceforge.net/mailarchive/forum.php?forum_name=openbabel-discuss here].
...insert links to gallery of poor bug reports
+
 
 +
=== 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.
 +
 
 +
# Go to the Open Babel [https://github.com/openbabel/openbabel/issues bug tracker]
 +
# If you have a GitHub account, please log in, or consider signing up (it's free)
 +
# To submit a new bug, click on the green "New issue"
 +
# Please read the instructions at the top of the "Write" Box
 +
# Fill in the remainder of the "Write" box 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.
 +
 
 +
===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]

Latest revision as of 13:30, 29 August 2017

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. We encourage you to subscribe to the list here, and then send your query to [email protected].

You can also email the list without subscribing, but your email will not appear for up to a week (emails are moderated on Tuesday mornings).

An archive of posts to the list can be accessed here.

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 GitHub account, please log in, or consider signing up (it's free)
  3. To submit a new bug, click on the green "New issue"
  4. Please read the instructions at the top of the "Write" Box
  5. Fill in the remainder of the "Write" box 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.

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: