search

Pirate-Weather / pirateweather

Code and documentation for the Pirate Weather API
Apache License 2.0
670 stars 29 forks source link

Cleanup Repos #33

Closed cloneofghosts closed 1 year ago

cloneofghosts commented 1 year ago

This isn't anything related to the API but with the recent updates the readmes for https://github.com/alexander0042/pirateweather and https://github.com/alexander0042/pirate-weather-ha are outdated and need updating.

Shouldn't the terms of service be moved from the portal site to the main website? Otherwise they're hidden and cannot be found easily. Also maybe https://github.com/alexander0042/weather-vue and https://github.com/alexander0042/alexander0042.github.io can be archived since they're not in use anymore? Might be woth looking into creating an organization for the PW repos though I think it would break the links?

As a sidenote maybe Discussions could be enabled here? There's an option in GitHub to enable them and they're kinda like forums.

cloneofghosts commented 1 year ago

@alexander0042 I'm going to separate this out into issues that you can probably close and ones that you should look into that have been sitting there for a whlie.

Can Close

Other Repos

HA Repo

Processing Code Repo

Backlog Items to Look Into

Other Repos

HA Repo

Processing Code Repo

Repos To Archive

alexander0042 commented 1 year ago

Really appreciate you pulling these all together in one place, it really helps me to focus on it! I'm away until next weekend, so but this cleanup is a great place for me to start

cloneofghosts commented 1 year ago

Went through the repos again and sorted it out into ones you can probably close and backlog items which have either been sitting there for a few weeks with no response or older ones with no activity for a while in the second comment.

I can always create a pull request which can automatically close and lock issues/pull requests which haven't had any activity on them after a certain amount of time. I know these repos don't have a ton of activity at the moment but it still could be something to add in case there are a lot of issues added in the future.

alexander0042 commented 1 year ago

Thanks for posting here again, this had fallen off my radar, but would be much cleaner! I totally agree that it would be better to close out some of the old/ non-actionable ones to keep things clean, and I think a time-based threshold is what's typically used. Is there some sort of way to automate it, since that would be ideal I think?

cloneofghosts commented 1 year ago

@alexander0042 Yes there is a way to automate it. You can use GitHub Workflows to have it automatically close issues/pulls after a certain amount of time.

This is how I have it setup on one of my own repos as an example https://github.com/cloneofghosts/soccersite/blob/master/.github/workflows/stale.yml

I can always set it up and create a PR for you to merge in if you prefer? If so then let me know how many days you want before the issue/pr gets marked as stale.

alexander0042 commented 1 year ago

Great, accepted and merged! Thank you so much for putting those files together, since it saved me having to figure it out 👍

cloneofghosts commented 1 year ago

@alexander0042 You're welcome! Reminder that anything assigned to you will not auto-close so I'd recommend going through the list and seeing which issues need to be assigned to you so they will/won't auto-close.

I also updated the list of issues you can close to ones that are assigned to you and left the others the same since they haven't been looked at yet.

EDIT: Added a closed issue from the HA repo since it seems like the issue wasn't fixed? Should reopen the issue so it doesn't get locked.

cloneofghosts commented 1 year ago

@alexander0042 Just going to combine the last two messages into one. There are also a few things missing from the site that should probably be updated:

Since you have discussions enabled on the repo it might be a good idea to convert https://github.com/alexander0042/pirateweather/issues/50 into a discussion. Discussions won't get auto closed and that issue is more of a discussion rather then an actual issue.

I noticed that the roadmap is missing a few items (in no particular order as I don't know what the priority list is)

Changelog is missing versions 1.5.1 and 1.5.2

Add in documentation for HA on the HA page https://pirateweather.net/en/latest/ha/

There's also discussions Pirate-Weather/pirate-weather-ha#62 and Pirate-Weather/pirateweather#89 which seem to have been missed

alexander0042 commented 1 year ago

Great points on everything here, and thanks for flagging those discussions (which were missed). I'm updating the road map with all of those now, since I agree that it's important to keep track of what the priorities are for this project. Alas, the changelog is trickier to fix, since those two versions were internal updates that never went live, and didn't actually change anything. Maybe I'll add a note in saying that though, since it is weird that they're just missing

cloneofghosts commented 1 year ago

I see that the roadmap has been updated and beside the older repos which should be archived (the old website and weather.pirateweather repos) I think this issue is good to close?

EDIT: It might be a good idea on the changelog page to have a section for upcoming releases (major releases only ie 1.6, 2.0, etc) with planned changes/release date. Should note somewhere that things are subject to change.

I'm assuming HA documentation is part of the the third item for API documentation and that only the HRRR Smoke model is planned for a AQI index?