Add documentation through Readme.md files to the repository #5149
Conversation
policyengine_us/variables/README.md
Outdated
| @@ -0,0 +1,24 @@ | |||
| ## Variables | |||
|
|
|||
| - Update the following files to add the state model into income tree: | |||
There was a problem hiding this comment.
I dont think we need this any more - all state model are complete
There was a problem hiding this comment.
We should rather highlight that each new program should be added to the net income tree to have an impact on the microsim / household
There was a problem hiding this comment.
lets focus here on formatting of the variables and methodology
Entities e.g.
| @@ -7,3 +7,67 @@ | |||
| PolicyEngine US is a microsimulation model of the US state and federal tax and benefit system. | |||
|
|
|||
| To install, run `pip install policyengine-us`. | |||
|
|
|||
| ## START | |||
There was a problem hiding this comment.
Lets make a section on:
How to contribute which is all from creating an issue to publishing a PR and requesting reviews
| ### When starting to work on a specific policy program | ||
| - First check the legal code of the program | ||
| - Model based on legal code structure | ||
| - Second check newest tax form for inflation adjusted amount confirmation |
There was a problem hiding this comment.
Could we add a section such as "Contributing on codespaces"
with the steps from the doc:
https://docs.google.com/document/d/1TTksYmtIXSNOG47H4m3733pvfvf2e3OXOvVQXE92FCQ/edit
There was a problem hiding this comment.
Also a section on contributing on vscode
1 page here:
https://docs.google.com/document/d/1HD4U0GZqHXIoPtnGMzueCUC-NYPiELN0hlVxmtSSEv8/edit
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5149 +/- ##
==========================================
- Coverage 99.13% 99.13% -0.01%
==========================================
Files 2587 2596 +9
Lines 37646 37750 +104
Branches 161 162 +1
==========================================
+ Hits 37319 37422 +103
Misses 296 296
- Partials 31 32 +1 ☔ View full report in Codecov by Sentry. |
policyengine_us/variables/README.md
Outdated
| @@ -0,0 +1,15 @@ | |||
| ## Variables | |||
|
|
|||
| - Useful variable classes: | |||
There was a problem hiding this comment.
I actually dont think we need this, it would be a lot more useful if we just go over general variable structure
No description provided.