search

NYCPlanning / db-knownprojects

KPDB: A compilation of prospective residential development projects from various sources, with rough projections of new unit counts
https://nycplanning.github.io/db-knownprojects
0 stars 0 forks source link

create issue template #366

Closed td928 closed 1 year ago

td928 commented 1 year ago

changes

todo

[ ] change filenames to align with their names in the extractors.py file

td928 commented 1 year ago

Does this change mean that there are two templates, one the in data repo for datasets we the extractor to process and one in the pipeline repo for the other data?

Hey @SashaWeinstein let me know if this is better now with just ones not updated in the data repo

td928 commented 1 year ago

Don't think it make sense to have outstanding issue tickets in the template? Those will stay in after they are addressed unless we have another PR to take them out of the template.

Better to add them via edit after an issue is created from the template imo

definitely I was thinking they might be good references for future release. Let me try to make that more explicit

SashaWeinstein commented 1 year ago

I don't think there should be an "Outstanding Issue Tickets" section at all? Like I guess we could add the outstanding work as new check boxes each time and think those changes and thew new data all bundled together as a data update. I see that the devDB does have an Update code section. If my understanding is correct that is what this section is intended as? I think it's more confusing than it is helpful and it's better to track enhancements and bug fixes with our typical ticketing process. But if you think it's clearer I guess I'm open. What do you think @mbh329?

mbh329 commented 1 year ago

Yeah I think it makes it more confusing than it has to be - the issue template can have notes about how to do things, where to find the data, how to update it etc...I feel like the existing issue templates are good examples

td928 commented 1 year ago

Yeah I think it makes it more confusing than it has to be - the issue template can have notes about how to do things, where to find the data, how to update it etc...I feel like the existing issue templates are good examples

ok what specific things in the existing issue templates are good examples? @mbh329 Happy to change the oustanding tickets to update code if that's more explicit. I did copied over the issue template for DevDB as a starting point so I am curious about what are your specific suggestions for KPDB.

SashaWeinstein commented 1 year ago

I think Max and I agree that the facDB issue template is better in this regard, and code updates should be kept off the dataloading issues

mbh329 commented 1 year ago

@td928 I updated the wording, let me know if that looks good. I realize that generally we would have someone else review the PR as we both contributed but I think its fine to merge in if you think its good