Contributors' Guidelines
==========================

Introduction
------------

The purpose of this document is to help contributors get started with
the OSI Visualizer codebase.


Reporting issues
----------------

The simplest way to contribute to OSI Visualizer is to report issues that you may
find with the project on `github <https://github.com/OpenSimulationInterface/osi-visualizer>`__. Everyone can create issues.
Always make sure to search the existing issues before reporting a new one.
Issues may be created to discuss:

- `Feature requests or Ideas <https://github.com/OpenSimulationInterface/osi-visualizer/issues/new?assignees=&labels=feature+request&template=feature_request.md&title=>`_
- `Bugs <https://github.com/OpenSimulationInterface/osi-visualizer/issues/new?assignees=&labels=bug&template=bug_report.md&title=>`_
- `Questions <https://github.com/OpenSimulationInterface/osi-visualizer/issues/new?assignees=&labels=question&template=question.md&title=>`_
- `Other <https://github.com/OpenSimulationInterface/osi-visualizer/issues/new>`_

If practicable issues should be closed by a referenced pull request or commit (`here <https://help.github.com/en/articles/closing-issues-using-keywords>`_ you can find keywords to close issues automatically). To help developers and maintainers we provide a `pull request template <https://github.com/OpenSimulationInterface/osi-visualizer/blob/master/.github/pull_request_template.md>`_ which will be generated each time you create a new pull request.

See `here <https://opensimulationinterface.github.io/osi-documentation/osi/howtocontribute.html#our-git-workflow>`_ for more on our git workflow.

Documentation
----------------

- Documentation changes can be performed by anyone.
- Consider adding stuff to the `osi-documentation <https://github.com/OpenSimulationInterface/osi-documentation>`_ or directly to the `doc <https://github.com/OpenSimulationInterface/osi-visualizer/tree/master/doc>`_ folder in the repository.
- When new changes are made directly to the `osi-documentation <https://github.com/OpenSimulationInterface/osi-documentation>`_ repo the documentation will be rebuild and the new changes can be seen. When making documentation changes in the `doc <https://github.com/OpenSimulationInterface/osi-visualizer/tree/master/doc>`_ folder of the repository the changes will be visible when the daily chron job of osi-documentation is executed.