search

18F / dsnap_rules

Other
3 stars 2 forks source link

Navigating the repo as a policy person #7

Open edmullen opened 6 years ago

edmullen commented 6 years ago

As I'm looking through the code for the first time, and not being a developer myself, I noticed a couple things that got me confused. If we are taking the route we are because we feel that python is pretty legible for the lay person, we may want to provide some support to those people who may look at it.

For example, inside the new_rules repo there is a folder called new_rules which has a file rules.py, but the rules the policy person cares about are another level down in dsnap_rules.py in the folder dsnap. Maybe we could have some content at the top level README with links pointing to the key files that speak to the program, letting that kind of viewer skip all the utilities/libraries/stuff they don't care about.

Similarly, the included comments ( like this ) are really helpful in confirming, "ok, I'm in the right place, this is what this part's going to talk about".

I recognize that we're just getting started and things will change, but offering it up to keep in mind. There's not really an "ask" here. Feel free to close once you've read.

vrajmohan commented 6 years ago

The components of a generic rules service, as opposed to those of specific services for D-SNAP, WIC, etc is still emergent. They may end up as separate repositories. For now, I am trying to postpone that decision by creating a rules.py which is for generic rules, and dsnap/dsnap_rules.py which is for D-SNAP specific rules. This breaks down for app.py, validate.py etc. as everything there is specific to DSNAP and there's not much that is generic.