NYCPlanning / NYCPlanning/data-engineering
PLUTO QA: DE to review documentation prior GIS QA
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 43
- Forks
- 3
- Avg merge
- 23h 3m
- Merged PRs (30d)
- 44
Description
This doesn't exactly need to be a GH issue but I'm creating it as a reminder to revisit later.
The goal of the issue is to get clarity what needs to be reviewed and confirmed in PLUTO data dict & readme.
Context:
GIS team reached out to explore if we can review PLUTO Readmes and/or data dicts as a part of our internal DE QA process, prior to sending PLUTO to GIS. I think it's mainly about us providing PLUTO logic changes upfront, not after GIS approves QA. We should check in w/AD or MC if there is anything else they normally look for in the docs.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the PLUTO Readmes and data dictionaries, then identify what PLUTO logic changes and documentation elements need review before GIS QA. Check with AD or MC about their usual documentation checks; done means agreeing on the DE QA scope and recording the review expectations.
Written by the indexing model from the issue text.
Assessment
- Domain
- data, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100