ER: Developers are creating branches off hackforla/website

roslynwythe commented 1 year ago

Dependency

[ ] #6416

Emergent Requirement - Problem

Developers inadvertently create extraneous branches off the hackforla/website repository (instead of creating branches on their fork) but they do not have rights to delete the extraneous branches. We need to prevent developers from creating these branches, and we require an issue template for instances for use when such a branch has been created and needs to be deleted.

Issue you discovered this emergent requirement in

N/A

Date discovered

discussed at meeting 6/12/2023

Did you have to do something temporarily

[x] YES
[ ] NO

We are currently pruning the branches manually, which is a waste of time.

Who was involved

Bonnie Wolfe, @JessicaLucindaCheng

What happens if this is not addressed

The branches will persist until deleted by a lead and the lead will need to figure out which branches can be deleted, which can take a lot of time and research.

Resources

Recommended Action Items

[x] Make a new issue
[ ] Discuss with team
[ ] Let a Team Lead know

Potential solutions [draft]

[x] prevent write members who are not part of merge team from creating branches
- @JessicaLucindaCheng implemented the solution for preventing members (aside from merge team) from creating branches off hackforla/website in the future by doing the following:
  Click here to see the detailed instructions
  1. On the repo, select Settings.
  2. On the left menu, select Branches.
  3. Select Edit for the branch rule named *. (Yes, the branch rule is named with the asterisk symbol).
  4. Scroll toward the bottom of the page. Then, you'll see the Restrict pushes that create matching branches; make sure the checkbox next to it is selected.
[ ] Write an issue for a back-end developer to work on creating an issue template that includes both:
- [ ] A section for reporting that a branch created on the Website repo needs to be removed
- [ ] A section with instructions for how to remove the branch.
- [ ] Instructions can be copied and pasted from [Insert link to instructions] into the issue template

github-actions[bot] commented 1 year ago

Hi @roslynwythe, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

roslynwythe commented 8 months ago

@JessicaLucindaCheng - I believe you have prevented future branches off hackforla/website. Can you advise whether we still need this ER?

JessicaLucindaCheng commented 8 months ago

@roslynwythe

@JessicaLucindaCheng - I believe you have prevented future branches off hackforla/website. Can you advise whether we still need this ER?

Before I can answer that, I have a question. Since merge team members can create branches but I don't think they can delete them, how will we know when a branch created by a merge team member needs to be deleted?

ExperimentsInHonesty commented 5 months ago

@JessicaLucindaCheng We can create an issue template I have updated the potential solution draft above and added check boxes. Are you ready for me to prioritize this?

github-actions[bot] commented 5 months ago

Hi @JessicaLucindaCheng, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

JessicaLucindaCheng commented 5 months ago

@ExperimentsInHonesty

@JessicaLucindaCheng We can create an issue template I have updated the potential solution draft above and added check boxes. Are you ready for me to prioritize this?

Yes, it's ready to be prioritized. Please note that I made some edits to the Potential Solutions (draft) section and changed the feature label.

ExperimentsInHonesty commented 5 months ago

@JessicaLucindaCheng I updated the possible solutions template part. From

Write an issue for a back-end developer to work on creating an issue template for reporting that a branch created by the Merge Team needs to be removed.

to

Write an issue for a back-end developer to work on creating an issue template for reporting that a branch created by the Merge Team needs to be removed. The issue template can be the report and the instructions for removing all in one.

If you agree, add ready for prioritization label, otherwise leave comment.

JessicaLucindaCheng commented 5 months ago

@ExperimentsInHonesty

@JessicaLucindaCheng I updated the possible solutions template part. From

Write an issue for a back-end developer to work on creating an issue template for reporting that a branch created by the Merge Team needs to be removed.

to

Write an issue for a back-end developer to work on creating an issue template for reporting that a branch created by the Merge Team needs to be removed. The issue template can be the report and the instructions for removing all in one.

If you agree, add ready for prioritization label, otherwise leave comment.

I think the report and instructions can be included in the issue template together. However, I think a person on the website-admins team would have to write the instructions because I don't think other members of the team would necessarily know how within the context of the repo's branch rules set up. So, I wrote #6416.
Also, I rewrote the instructions to be:
- [ ] Write an issue for a back-end developer to work on creating an issue template that includes both:
  - [ ] A section for reporting that a branch created on the Website repo needs to be removed
  - [ ] A section with instructions for how to remove the branch.
  - [ ] Instructions can be copied and pasted from [Insert link to instructions] into the issue template

Next steps

[x] Product:
- [x] Prioritize #6416
- [x] For this ER (#4876),
- [x] Remove the ready for product label
- [x] Add a ready for dev lead label
- [x] Move this ER into the Ice Box

JessicaLucindaCheng commented 4 months ago

Merge Team member or Technical Lead

[ ] Once the issue in the Dependency section of this ER is closed, review this ER and make it ready for prioritization. Add a ready for prioritization label.

hackforla / website