Contributing

Issues and PRs are always welcomed!

To minimize the time there are a few instructions on new issues and PRs

Issues

Before opening an issue, please be sure that the problem has not been mentioned in any source:

  1. Documentation
  2. Method paper
  3. Discussion
  4. Open/Closed issues

For bug reportings, please provide:

  • A reproducible MWE (minimal working example)
  • Running environment (for example, call versioninfo() in Julia)
  • Copied lines, shortcuts, captured videos, or any kind of error output

PRs

New PRs should have:

  • A few words in summary of new modifications
  • Auto-test for new functions
  • Documentation for new features
  • Comments on complicated algorithms