Warning

You are reading the documentation related to the development version. Go here if you are looking for the documentation of the stable release.

Reporting Issues

All contributions, bug reports, bug fixes, enhancements requests and ideas are welcome

Bug reports are a very important part of any software project. Helping us to discover issues or proposing enhancements should allow making SpectroChemPy more stable, reliable and adapted to more scientific activities.

You can report the Bug(s) you discover or the Feature Requests to the Issue Tracker

Warning

The issue tracker is hosted on well known GitHub platform. If you do not sign in, you will have only read right on the issues page. Thus, to be able to post issues or feature requests you need to register for a free GitHub account.

Before creating a new issue, it is worth searching for existing bug reports and pull requests to see if the problem has already been reported and may be already fixed.

Bug reports should :

  1. Include a short stand-alone Python snippet reproducing the problem.

    You can format the code using GitHub Flavored Markdown

    >>> from spectrochempy import *
    SpectroChemPy's API ...
    
    >>> nd = NDDataset()
    
  2. Include the full version string of SpectroChemPy . You can use the built in property

    >>> print(version)
    0.1.23...
    
  3. Explain why the current behavior is wrong/not desired and what you expect instead.

The issue will then ishow up to the SpectroChemPy community and be open to comments/ideas from others.