country-template
country-template copied to clipboard
Rename Country Template
This repository offers great value to:
- Get started with modelling a new jurisdiction.
- Do regression testing for Core developers.
- Demonstrate best modelling practices.
- Provide code examples that are always kept up-to-date and that are independent from any real country, thereby limiting accusations of being country-specific.
However, its name implies that:
- It is a template (whereas it is also directly executable).
- An OpenFisca package necessarily models the jurisdiction of a country (whereas it could also be an industry-specific model).
I thus suggest to rename “Country Template” to something that more accurately reflects its actual usage.
Decision process
- This RFC will be open for one week, after which the votes will be counted and a conclusion will be written.
- Please use emoji reaction :+1: to vote for the solution(s) you prefer.
- Additional propositions, including incremental improvements to the existing propositions, are welcome as long as they respect the same format.
- A change will only be enacted if at least 3 people vote for an alternative to the current status quo.
Proposition 1
“Demo”
- This repository would be called:
@openfisca/demo
. - The published package on Pypi would be called:
https://pypi.org/project/OpenFisca-Demo/
. - We would refer to it in the documentation as “As can be seen in the Demo” or as “As can be seen in the Demo repository” or as “As can be seen in the Demo package”.
Proposition 2
“Country Template” (no change)
- This repository would be called:
@openfisca/country-template
. - The published package on Pypi would be called:
https://pypi.org/project/OpenFisca-Country-Template/
. - We would refer to it in the documentation as “As can be seen in the Country Template≥” or as “As can be seen in the Country Template repository” or as “As can be seen in the Country Template package”.
Proposition 3
“Example”
- This repository would be called:
@openfisca/example
. - The published package on Pypi would be called:
https://pypi.org/project/OpenFisca-Example/
. - We would refer to it in the documentation as “As can be seen in the Example” or as “As can be seen in the Example repository” or as “As can be seen in the Example package”.
I would like to add a fourth proposition...
Proposition 4
“OpenFisca Template”
- This repository would be called:
@openfisca/openfisca-template
. - The published package on Pypi would be called:
https://pypi.org/project/OpenFisca-Template/
. - We would refer to it in the documentation as “As can be seen in the OpenFisca Template” or as “As can be seen in the OpenFisca Template repository” or as “As can be seen in the OpenFisca Template package”.
Aaand “Demo” wins! Thanks everyone for your participation 🙂 I'll lock the issue to preserve votes.