.. _contributing:

Contributing
============

We welcome and appreciate all contributions!
Every little bit helps, and credit will always be given.

Bug Reports
-----------

To report a bug, please submit an issue on
`GitHub <https://github.com/Stanford-NavLab/gnss_lib_py/issues>`__.
In your issue, please include:

    * Your operating system name and version.
    * Any details about your local setup that might be helpful in
      troubleshooting.
    * A minimal working example (MWE) to reproduce the bug. An MWE
      helps us reproduce the bug and troubleshoot the problem.
      For more details on how to create an MWE, see
      `this Stack Overflow guide <https://stackoverflow.com/help/minimal-reproducible-example>`.

Feature requests and feedback
-----------------------------

The best way to any send feedback is to file an issue on
`GitHub <https://github.com/Stanford-NavLab/gnss_lib_py/issues>`__.

If you are proposing a feature:

    * Explain in detail the intended feature, its purpose and how it
      would work.
    * Keep the scope as narrow as possible, which will make it easier to
      implement.
    * This is a volunteer driven project and most contributions are a
      result of other research projects. We welcome outside implementations
      of additional features. If you implement your requested feature
      and submit a pull request, we will incorporate it.

Additional Contributing Pages
-----------------------------

We have a set of detailed :ref:`development guides<development>` depending
on whether you are a public user, Stanford NAV Lab member, or a project
maintainer.

For increased user confidence, we have implemented unit tests for our
code. We have pages on how to :ref:`write and run tests<testing>` and
how to create and analyze :ref:`coverage reports<coverage>`.

The :ref:`Documentation<documentation>` section includes a detailed
guide on how to write and build documentation.

.. toctree::
   development
   testing
   documentation
   :maxdepth: 1