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

Merge DummyCountry and Country Template #4

Merged
merged 43 commits into from
May 17, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
225f7f5
Demonstrate usage of all variable types
fpagnoux Apr 21, 2017
0760596
Remove commented failing test
fpagnoux Apr 21, 2017
d8d41c2
Unify whitespace and casing
MattiSG Apr 21, 2017
a27a80b
Document the modelled example
MattiSG Apr 21, 2017
88f4eac
Add and pass tests about basic income
fpagnoux Apr 21, 2017
dc2c5d2
Split parameter file
fpagnoux Apr 24, 2017
8a6bb3a
Configure and pass flake8 linting
fpagnoux Apr 24, 2017
c387285
Set up continuous integration
fpagnoux Apr 24, 2017
9a791db
Add BAREME exemple
fpagnoux Apr 24, 2017
cab4e14
Improve .gitignore
fpagnoux May 12, 2017
1a4daf0
Add Makefile
fpagnoux May 14, 2017
783f86d
Add License
fpagnoux May 14, 2017
0e2e980
Add nose to tests dependencies
fpagnoux May 14, 2017
31884a8
Add YAML test runner
fpagnoux May 14, 2017
bbb4f83
Update parameter definition
fpagnoux May 15, 2017
f7c0507
Improve age
fpagnoux May 15, 2017
f03cd27
Introduce a yearly variable
fpagnoux May 15, 2017
de39f09
Add household subroles
fpagnoux May 15, 2017
8769e11
Fixup child plural
fpagnoux May 15, 2017
90fe4de
Introduce housing_allowance
fpagnoux May 15, 2017
50ac04e
Add values history for income_tax_rate
fpagnoux May 15, 2017
755213a
Add reforms
fpagnoux May 15, 2017
5e49266
Introduce birth
fpagnoux May 15, 2017
56ae49e
Add url to pypi package
fpagnoux May 15, 2017
4419014
Use plural for benefits and taxes
fpagnoux May 16, 2017
74ba1f9
Add YAML tests for all formulas
fpagnoux May 16, 2017
ff50bd6
Improve entities file description
fpagnoux May 16, 2017
44e559c
Improve CI tests
fpagnoux May 16, 2017
0d661a6
Upgrade core version
fpagnoux May 16, 2017
e8afc02
Package all files in pip
fpagnoux May 16, 2017
4f2bad7
Add a PR template
fpagnoux May 16, 2017
3fa85c1
Add issue template
fpagnoux May 16, 2017
8fd5459
Bump version number
fpagnoux May 16, 2017
2e71a0c
Add Contributing
fpagnoux May 16, 2017
11c74e8
Update bootstrapping script
fpagnoux May 16, 2017
ed45c02
Don't install package in editable mode
fpagnoux May 17, 2017
55f908a
Improve gitignore readability
MattiSG May 17, 2017
945ff2b
Fix typos
MattiSG May 17, 2017
09f894c
Improve descriptions
MattiSG May 17, 2017
a90be94
Fix whitespace
MattiSG May 17, 2017
41b6fe9
Improve CI config file readability
MattiSG May 17, 2017
8d37a5d
Improve and simplify version bump check
MattiSG May 17, 2017
1024f76
Improve documentation
MattiSG May 17, 2017
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Hi there!

I really enjoy OpenFisca, but I recently encountered an issue.

### Here is what I did:


### Here is what I expected to happen:


### Here is what actually happened:


### Here is data (or links to it) that can help you reproduce this issue:



## Context

I identify more as a:

- Analyst _(I make macroscopic computations on real populations)_.
- Business expert _(I create tests and model legislation)_.
- Commenter _(I make data visualisations)_.
- Developer _(I create tools that use the existing OpenFisca code)_.
- Historian _(I accumulate data based on past legislation values)_.
- Lobbyist _(I model reforms to make them exist)_.
- Producer _(I make computations on individual situations)_.

(remove this line as well as all items in the list that don't fit your situation)
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Thanks for contributing to OpenFisca ! Please remove this line, as well as, for each line below, the cases which are unrelevant to your contribution :)

* Tax and benefit system evolution. | Technical improvement. | Crash fix. | Minor change.
* Impacted periods: all. | until DD/MM/YYYY. | from DD/MM/YYYY.
* Impacted areas: `path/to/file/containing/impacted/variables`
* Details:
- New feature or new behaviour description
- Cases for which an error was noticed

- - - -

These changes _(remove lines which are unrelevant to your contribution)_:

- Impact the OpenFisca-Country-Template public API (for instance renaming or removing a variable)
- Add a new feature (for instance adding a variable)
- Fix or improve an already existing calculation.
- Change non-functional parts of this repository (for instance editing the README)
17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
# Python builds

*.egg-info
*.pyc
build
dist

# Editors

.project
.pydevproject
.settings
.spyderproject
.vscode

# OS stuff

.DS_Store
*~
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# 1.0.0 - [#4](https://github.com/openfisca/country-template/pull/4)

* Tax and benefit system evolution.
* Impacted periods: all.
* Impacted areas:
- `benefits`
- `demographics`
- `housing`
- `income`
- `taxes`
* Details:
- Build the skeleton of the tax and benefit system
98 changes: 98 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
> This file defines the rules to follow to contribute to your repository.
> The rules suggested here are what we generally use for OpenFisca country packages.
> You can of course edit them, and you should probably remove this block :)

Thank you for wanting to contribute to OpenFisca! :smiley:

TL;DR: [GitHub Flow](https://guides.github.com/introduction/flow/), [SemVer](http://semver.org/).


## Pull requests

We follow the [GitHub Flow](https://guides.github.com/introduction/flow/): all code contributions are submitted via a pull request towards the `master` branch.

Opening a Pull Request means you want that code to be merged. If you want to only discuss it, send a link to your branch along with your questions through whichever communication channel you prefer.

### Peer reviews

All pull requests must be reviewed by someone else than their original author.

> In case of a lack of available reviewers, one may review oneself, but only after at least 24 hours have passed without working on the code to review.

To help reviewers, make sure to add to your PR a **clear text explanation** of your changes.

In case of breaking changes, you **must** give details about what features were deprecated.

> You must also provide guidelines to help users adapt their code to be compatible with the new version of the package.


## Advertising changes

### Version number

We follow the [semantic versioning](http://semver.org/) spec: any change impacts the version number, and the version number conveys API compatibility information **only**.

Examples:

#### Patch bump

- Fixing or improving an already existing calculation.

#### Minor bump

- Adding a variable to the tax and benefit system.

#### Major bump

- Renaming or removing a variable from the tax and benefit system.

### Changelog

OpenFisca-Country-Template changes must be understood by users who don't necessarily work on the code. The Changelog must therefore be as explicit as possible.

Each change must be documented with the following elements:

- On the first line appears as a title the version number, as well as a link towards the Pull Request introducing the change. The title level must match the incrementation level of the version.


> For instance :
> # 13.0.0 - [#671](https://github.com/openfisca/openfisca-france/pull/671)
>
> ## 13.2.0 - [#676](https://github.com/openfisca/openfisca-france/pull/676)
>
> ### 13.1.5 - [#684](https://github.com/openfisca/openfisca-france/pull/684)

- The second line indicates the type of the change. The possible types are:
- `Tax and benefit system evolution`: Calculation improvement, fix, or update. Impacts the users interested in calculations.
- `Technical improvement`: Performances improvement, installing process change, formula syntax change… Impacts the users who write legislation and/or deploy their own instance.
- `Crash fix`: Impact all reusers.
- `Minor change`: Refactoring, metadata… Has no impact on users.

- In the case of a `Tax and benefit system evolution`, the following elements must then be specified:
- The periods impacted by the change. To avoid any ambiguity, the start day and/or the end day of the impacted periods must be precised. For instance, `from 01/01/2017` is correct, but `from 2017` is not, as it is ambiguous: it is not clear wheter 2017 is included or not in the impacted period.
- The tax and benefit system areas impacted by the change. These areas are described by the relative paths to the modified files, without the `.py` extension.

> For instance :
> - Impacted periods: Until 31/12/2015.
> - Impacted areas: `benefits/healthcare/universal_coverage`

- Finally, for all cases except `Minor Change`, the changes must be explicited by details given from a user perspective: in which case was an error or a problem was noticed ? What is the new available feature ? Which new behaviour is adopted.

> For instance:
>
> * Details :
> - These variables now return a yearly amount (instead of monthly):
> - `middle_school_scholarship`
> - `high_school_scholarship`
> - _The previous monthly amounts were just yearly amounts artificially divided by 12_
>
> or :
>
> * Details :
> - Use OpenFisca-Core `12.0.0`
> - Change the syntax used to declare parameters:
> - Remove "fuzzy" attribute
> - Remove "end" attribute
> - All parameters are assumed to be valid until and end date is explicitely specified with an `<END>` tag

When a Pull Request contains several disctincts changes, several paragraphs may be added to the Changelog. To be properly formatted in Markdown, these paragraphs must be separated by `<!-- -->`.
Loading