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. 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

• Bugs

• Questions

• Other

If practicable issues should be closed by a referenced pull request or commit (here you can find keywords to close issues automatically). To help developers and maintainers we provide a pull request template which will be generated each time you create a new pull request.

See here for more on our git workflow.

Documentation

• Documentation changes can be performed by anyone.

• Consider adding stuff to the osi-documentation or directly to the doc folder in the repository.

• When new changes are made directly to the osi-documentation repo the documentation will be rebuild and the new changes can be seen. When making documentation changes in the doc folder of the repository the changes will be visible when the daily chron job of osi-documentation is executed.