Unverified Commit a9a2a9fe authored by Axel Kohlmeyer's avatar Axel Kohlmeyer
Browse files

provide updated information on how to report bugs on github or via e-mail

parent f386598c
Loading
Loading
Loading
Loading
+37 −19
Original line number Diff line number Diff line
Reporting bugs
==============

If you are confident that you have found a bug in LAMMPS, follow these
steps.
If you are confident that you have found a bug in LAMMPS, please follow the steps outlined below:

Check the `New features and bug fixes <http://lammps.sandia.gov/bug.html>`_ section of the `LAMMPS WWW site <lws_>`_ to see if the bug has already been reported or fixed or the
`Unfixed bug <http://lammps.sandia.gov/unbug.html>`_ to see if a fix is
pending.
 * Check the `New features and bug fixes
   <http://lammps.sandia.gov/bug.html>`_ section of the `LAMMPS WWW site
   <lws_>`_ to see if the bug has already been addressed in a patch.
 * Check that your issue can be reproduced with the latest development
   version of LAMMPS.
 * Check the manual carefully to verify that the unexpected behavior you
   are observing is indeed in conflict with the documentation
 * Check the `GitHub Issue page <gip_>`_
   if your issue has already been reported and if it is still open.
 * Check the `GitHub Pull Requests page <https://github.com/lammps/pulls>`_
   if there is alread a fix for your bug pending.
 * Check the `mailing list archives <http://lammps.sandia.gov/mail.html>`_
   to see if the issue has been discussed before.

Check the `mailing list <http://lammps.sandia.gov/mail.html>`_ to see if
it has been discussed before.
If none of these steps yields any useful information, please file
a new bug report on the `GitHub Issue page <gip_>`_\ .
The website will offer you to select a suitable template with explanations
and then you should replace those explanations with the information
that you can provide to reproduce your issue.

If not, send an email to the mailing list describing the problem with
any ideas you have as to what is causing it or where in the code the
problem might be.  The developers will ask for more info if needed,
such as an input script or data files.
The most useful thing you can do to help us verify and fix a bug is to
isolate the problem.  Run it on the smallest number of atoms and fewest
number of processors with the simplest input script that reproduces the
bug.  Try to identify what command or combination of commands is
causing the problem and upload the complete input deck as a tar or zip
archive.  Please avoid using binary restart files unless the issue requires
it.  In the latter case you should also include an input deck to quickly
generate this restart from a data file or a simple additional input.

The most useful thing you can do to help us fix the bug is to isolate
the problem.  Run it on the smallest number of atoms and fewest number
of processors and with the simplest input script that reproduces the
bug and try to identify what command or combination of commands is
causing the problem.
You may also send an email to the LAMMPS mailing list at
"lammps-users at lists.sourceforge.net" describing the problem with the
same kind of information.  The mailing list can provide a faster response,
especially if the bug reported is actually expected behavior.  But because
of the high volume of the mailing list, it can happen that your e-mail
is overlooked and then forgotten.  Issues on GitHub have to be explicitly
closed, so that will *guarantee* that at least one LAMMPS developer will
have looked at it.

.. note::

   this page needs to have GitHub issues info added
.. _lws: http://lammps.sandia.gov
.. _gip: https://github.com/lammps/issues