-
Notifications
You must be signed in to change notification settings - Fork 56
Open
Labels
good first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
RP2 and DaLI have a programmable plugin architecture for countries, accounting methods, report generators and more. Adding support for a new country is a high-impact activity because it allows many new potential users to get access to RP2 and DaLI.
Here's how to add support for a new country:
- add a new country plugin to RP2;
- if the country requires accounting methods that aren't already supported in RP2, add the necessary accounting method plugins;
- ensure any newly added accounting methods are reflected in the country plugin's
get_default_accounting_method()andget_accounting_methods()methods; - optionally, new country-specific report generators can be added. The built-in report generators (i.e. rp2_full_report and open_positions) are automatically supported;
- only for non-English speaking countries: translations for the built-in report generators and for any new report generator can be added;
- ensure any newly added report generators are reflected in the country plugin's
get_report_generators()method; - add the same country plugin to DaLI. The implementation on the DaLI side is trivial: it's just an entry point instantiating the RP2 country plugin and passing it to the main function;
- update the documentation of RP2 and DaLI to reflect the new country, accounting methods (if any) and report generators (if any).
If you notice the country-specific infrastructure is missing a feature that is required to express taxes for the new country, open an issue to let the RP2 community know.
Metadata
Metadata
Assignees
Labels
good first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed