Skip to contents

Contributing to AISanalyze

Source: CONTRIBUTING.md

The aim of AISanalyze is to provide reliable and reproducible tools for analysing Automatic Identification System (AIS) data. Contributions improving performance, documentation, testing, or functionality are welcome, including:

  • Reporting bugs.
  • Suggesting new features or improvements.
  • Improving the documentation or examples.
  • Submitting pull requests.

Reporting issues

Please use the GitHub Issues page to report bugs or request new features.

When reporting a bug, please include:

  • the version of AISanalyze;
  • your R version (sessionInfo());
  • a minimal reproducible example;
  • the complete error message, if applicable.

Pull requests

Before submitting a pull request, please:

  • follow the existing coding style;
  • document any new exported functions using roxygen2;
  • add or update unit tests when appropriate;
  • ensure that devtools::check() completes without errors.

Questions

If you have questions about using AISanalyze, please contact or open a GitHub Discussion or Issue.

Thank you for helping improve AISanalyze!