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. 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 to reproduce the bug.

Feature requests and feedback

The best way to send feedback is to file an issue on GitHub.

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. If you implement your requested feature and submit a pull request, we will incorporate it.

Additional Contributing Pages

We have a set of detailed development guides 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 write and run tests and how to create and analyze coverage reports.

The Documentation section includes a detailed guide on how to write and build documentation.