Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Country Template #145

Open
MattiSG opened this issue Apr 29, 2024 · 5 comments
Open

Rename Country Template #145

MattiSG opened this issue Apr 29, 2024 · 5 comments
Assignees
Labels
policy:rfc Request for comments

Comments

@MattiSG
Copy link
Member

MattiSG commented Apr 29, 2024

This repository offers great value to:

  1. Get started with modelling a new jurisdiction.
  2. Do regression testing for Core developers.
  3. Demonstrate best modelling practices.
  4. 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:

  1. It is a template (whereas it is also directly executable).
  2. 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 👍 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.
@MattiSG MattiSG added the policy:rfc Request for comments label Apr 29, 2024
@MattiSG MattiSG self-assigned this Apr 29, 2024
@MattiSG
Copy link
Member Author

MattiSG commented Apr 29, 2024

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”.

@MattiSG
Copy link
Member Author

MattiSG commented Apr 29, 2024

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”.

@MattiSG
Copy link
Member Author

MattiSG commented Apr 29, 2024

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”.

@verbman
Copy link
Contributor

verbman commented May 7, 2024

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”.

@MattiSG
Copy link
Member Author

MattiSG commented May 17, 2024

Aaand “Demo” wins! Thanks everyone for your participation 🙂
I'll lock the issue to preserve votes.

@openfisca openfisca locked as resolved and limited conversation to collaborators May 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
policy:rfc Request for comments
Projects
None yet
Development

No branches or pull requests

2 participants