English | Deutsch
Thank you for helping to improve pksR. Bug reports, questions and pull requests are welcome.
Where to report what
-
The package (an error, a confusing message, a missing feature): open an issue at https://github.com/ofurkancoban/pksR/issues. Please include a small example that shows the problem and the output of
sessionInfo(). -
The data (a wrong value, a missing district or year, a wrong offence label): open an issue at https://github.com/ofurkancoban/pksR-data/issues. Please name the data version (
attr(d, "data_version")), year, district code (ags) and offence key, and if you can, the value in the original BKA table.
Pull requests
- Open an issue first for anything larger than a typo, so we can agree on the approach.
- Fork the repository and create a branch from
main. - Add or update tests in
tests/testthat/. Tests run offline: they use the fixture release intests/testthat/fixtures/releaseand never contact GitHub or the BKA. - Run
devtools::document(),devtools::test()anddevtools::check()before you push. - 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
cliand are wrapped intr(). After adding or changing a message, runRscript data-raw/translations.Rand add the German text toinst/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 ininst/i18n/de.po, Hilfeseiten einen AbschnittDeutsch.