Skip to contents

English | Deutsch

Thank you for helping to improve pksR. Bug reports, questions and pull requests are welcome.

Where to report what

Pull requests

  1. Open an issue first for anything larger than a typo, so we can agree on the approach.
  2. Fork the repository and create a branch from main.
  3. Add or update tests in tests/testthat/. Tests run offline: they use the fixture release in tests/testthat/fixtures/release and never contact GitHub or the BKA.
  4. Run devtools::document(), devtools::test() and devtools::check() before you push.
  5. Use Conventional Commits for commit messages and the pull request title, for example fix(api): keep Berlin in the example panel. Types: feat, fix, data, docs, test, refactor, perf, build, ci, chore, revert.

Style

  • Code, comments, commit messages and file names are in English.
  • Call functions of other packages with pkg::fun().
  • Messages go through cli and are wrapped in tr(). After adding or changing a message, run Rscript data-raw/translations.R and add the German text to inst/i18n/de.po.
  • Documentation is bilingual: every help page has a @section Deutsch:, and each vignette has a German version (*-de.Rmd).
  • Do not use em dashes or en dashes; use colons, commas or parentheses.

Code of conduct

Please be kind and constructive. We follow the rOpenSci Code of Conduct.

Deutsch

Danke, dass Sie pksR verbessern möchten.

  • Fehler im Paket melden Sie unter https://github.com/ofurkancoban/pksR/issues, mit einem kleinen Beispiel und sessionInfo().
  • Fehler in den Daten melden Sie unter https://github.com/ofurkancoban/pksR-data/issues, mit Datenversion, Jahr, Kreisschlüssel (ags), Straftatenschlüssel und, wenn möglich, dem Wert in der BKA-Tabelle.
  • Pull Requests: zuerst ein Issue öffnen, Tests ergänzen (sie laufen ohne Internet), vor dem Push devtools::check() ausführen, Commit-Nachrichten nach Conventional Commits. Code und Commits sind auf Englisch; Meldungen bekommen ihre deutsche Übersetzung in inst/i18n/de.po, Hilfeseiten einen Abschnitt Deutsch.