Merge DummyCountry and Country Template #4
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fpagnoux
force-pushed
the
merge-dummy-boilerplate
branch
from
ef4adcf to
8cb3297
Compare
fpagnoux
force-pushed
the
merge-dummy-boilerplate
branch
6 times, most recently
from
0a4ffbd to
2fc4778
Compare
MattiSG
requested changes
May 17, 2017
.gitignore
Outdated
| .project | ||
| .project | ||
| .pydevproject | ||
| .pydevproject |
.gitignore
Outdated
| .spyderproject | ||
| .vscode | ||
| build | ||
| dist |
There was a problem hiding this comment.
It is a good practice to group and name blocks, in order to increase readability and maintainability of the list.
Examples:
CONTRIBUTING.md
Outdated
| @@ -0,0 +1,98 @@ | |||
| > This files defines the rules to follow to contribute to your repository. | |||
README.md
Outdated
| @@ -19,32 +18,50 @@ git clone https://github.com/openfisca/country-template.git # download this tem | |||
| mv country-template openfisca-$lowercase_country_name | |||
| cd openfisca-$lowercase_country_name | |||
| git remote remove origin | |||
| sed -i '' "s/country_template/$lowercase_country_name/g" MANIFEST.in openfisca_country_template/base.py openfisca_country_template/model.py | |||
| sed -i '' "s/Country-Template/$COUNTRY_NAME/g" setup.py | |||
| sed -i '' '3,27d' README.md | |||
There was a problem hiding this comment.
Add comments to explain what this does.
README.md
Outdated
|
|
||
| > We recommend that you [use a virtualenv](https://doc.openfisca.fr/for_developers.html#create-a-virtualenv) to install OpenFisca. If you don't, you may need to add `--user` at the end of all commands starting by `pip`. | ||
|
|
||
| To install your country package, run: | ||
|
|
||
| ``` | ||
| pip install -e . | ||
| pip install -e ".[test]" | ||
| ``` | ||
|
|
||
| You can make sure that everything is working by running the provided test: |
| <!-- See https://doc.openfisca.fr/parameters.html --> | ||
| <NODE code="general"> | ||
| <CODE code="age_of_majority" description="Age of majority"> | ||
| <!-- This parameter has changed on the 1st of Jan 1971. --> |
There was a problem hiding this comment.
“has changed” → “has last changed”
| <!-- Unlike variables, parameters are not specific to a certain person or household. They are set by the legislation on depend on time. --> | ||
| <!-- See https://doc.openfisca.fr/parameters.html --> | ||
| <NODE code="general"> | ||
| <CODE code="age_of_majority" description="Age of majority"> |
There was a problem hiding this comment.
“Age of majority” → “Age of majority (in years)”
| #! /usr/bin/env python | ||
| # -*- coding: utf-8 -*- | ||
|
|
||
| # This file browses the country package to find yaml tests and runs them. |
| label = "Basic income provided to adults" | ||
| url = "https://law.gov.example/basic_income" # Always use the most official source | ||
|
|
||
| # Since Dec 1st 2016, the basic income is provided to any adult, without cousidering their income. |
| column = IntCol | ||
| entity = Person | ||
| definition_period = MONTH | ||
| label = u"Person's age" |
MattiSG
approved these changes
May 17, 2017
To be closer to production conditions
Group by blocks Remove duplicate lines
Exit with different exit codes depending on the type of error
fpagnoux
force-pushed
the
merge-dummy-boilerplate
branch
from
d4c133c to
1024f76
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Connected to openfisca/openfisca-core#492