codeforpdx / PASS

PASS project - with HMIS module integration
MIT License
30 stars 26 forks source link

Simplify Github templates #439

Closed timbot1789 closed 11 months ago

timbot1789 commented 1 year ago

This PR:

I find the formatting of our github templates hard to read, and I notice no one is really ever filling it out. I want to remove some unnecessary/redundant sections. This description is my proposed PR template.

1.
2. If needed, delete if not
3. If needed, delete if not

Screenshots (if applicable):

Add any screenshots/videos here.

Additional Context (optional):

Add any other context about the PR here.

Future Steps/PRs Needed to Finish This Work (optional):

Add any other steps/PRs that may be needed to continue this work if this PR is just a step in the right direction.

Issues needing discussion/feedback (optional):

1.
2. If needed, delete if not
3. If needed, delete if not

xscottxbrownx commented 1 year ago

Personally, I don't think the thin lines break up the sections enough - but I'm not married to the current template by any means. Not a big enough issue for me to argue. I'd be perfectly okay with removing the thicker lines.

Screenshot 2023-10-05 at 4 20 49 PM

But I think ⬆️ here shows how each section is clearly divided. The automatic heading lines only underline the heading basically.


While we are at it, I vote to eliminate the The Files This PR Effects section - all of that info is found in the Files changed tab of the PR itself.

timbot1789 commented 1 year ago

Personally, I don't think the thin lines break up the sections enough - but I'm not married to the current template by any means. Not a big enough issue for me to argue. I'd be perfectly okay with removing the thicker lines.

Screenshot 2023-10-05 at 4 20 49 PM

But I think ⬆️ here shows how each section is clearly divided. The automatic heading lines only underline the heading basically.

While we are at it, I vote to eliminate the The Files This PR Effects section - all of that info is found in the Files changed tab of the PR itself.

Idk maybe the issue I have is that no one is actually filling out any of these forms. At least for me, part of the reason is I see all these big thick lines and my mind goes "Ok stop here", and doesn't go further.

Maybe a happy middle is removing / combining some of these sections. I'll put up another commit with your suggestion, Scott.

xscottxbrownx commented 12 months ago

@timbot1789 not sure if this is technically ready for review or not, but I'm still okay with getting rid of the lines.

I also propose dropping the concise title sections - as we already type a title for the Issue or PR (we dropped it for PR template.)

Maybe we also adjust the github auto-template stuff (whatever you want to call it) at the top of the files, or drop them too... Like the Enhancement Request Issue has a title of Enhancement - [your title], and a label of enhancement. Maybe we can do the same for Bug Report & Feature Request.

timbot1789 commented 11 months ago

@xscottxbrownx @Jared-Krajewski responded to all your comments. I think this is gtg.