PolicyEngine / PolicyEngine/policyengine-core

Reference for uprating

Open
#215 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
22
Forks
30
Avg merge
14h 33m
Merged PRs (30d)
7

Description

Currently we document uprating references with the rest of the parameter, despite them tending to be in a separate subsection from the main parameters. Could we add a reference field to uprating, or an uprating section to references?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the documentation for parameters and uprating references in the repository, then compare how the two sections are structured. The work is done when uprating references have a dedicated, clearly organized location rather than being documented with the main parameter references.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.