Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ER: update the pull request contributing guidelines #6990

Closed
4 of 5 tasks
ino-iosdev opened this issue Jun 12, 2024 · 6 comments
Closed
4 of 5 tasks

ER: update the pull request contributing guidelines #6990

ino-iosdev opened this issue Jun 12, 2024 · 6 comments
Assignees
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue ER Emergent Request Feature: Onboarding/Contributing.md Issue Making: Level 2 Make issue(s) from an ER or Epic role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours

Comments

@ino-iosdev
Copy link
Member

ino-iosdev commented Jun 12, 2024

Emergent Requirement - Problem

This problem was brought up during the weekly Sunday meeting on 06/09/24.

We want the title of the PR to clearly summarize how the dev resolved the issue. When devs unnecessarily include the issue number in the title, the issue number collides with the PR number making it unclear which is which, and is a detriment to clear communication. Here is an example:

Screenshot 2024-06-11 at 6 14 19 PM

Issue you discovered this emergent requirement in

Date discovered

  • 06/09/24

Did you have to do something temporarily

  • YES
  • NO

Who was involved

@ino-iosdev
@t-will-gillis

What happens if this is not addressed

  • Repetitive change request in PR review
  • Reduce PR review efficiency

Resources

CONTRIBUTING.md#part-3-pull-requests

Recommended Action Items

  • Make a new issue
  • Discuss with team
  • Let a Team Lead know

Potential solutions [draft]

In CONTRIBUTING.md, Section 3.1.b.i. Replace:

* When the pull request is opened, the title input box will be the where the cursor defaults to.
* The default title will be your last commit message from your branch.
  * Please change it to provide a summary of what you did.
  * For our example (PR [Update Care Link in Credits Page - #2131](https://github.com/hackforla/website/pull/2131)), [@adrian-zaragoza](https://github.com/adrian-zaragoza) provided the following title:

  ````
  Update Care Link in Credits Page
  ````

**Advice:** Provide a 4-12 word summary of your resolution to the issue you are handling.

with:

* When the pull request is opened, the cursor will be located in the title input box, and the default title will be your last commit message from your branch.
* Change the title to a short summary of what you did on the issue: 
  * **Advice:** Provide a 4-12 word description of your resolution to the issue
  * For our example, [@adrian-zaragoza](https://github.com/adrian-zaragoza) provided the following title:

      `Update Care Link in Credits Page`

  * **Note:** Upon creation, the pull request number will be appended to the title automatically. To avoid confusion, please **do not include** the issue number in the title. 
  * The final title from our example is:  
      [Update Care Link in Credits Page #2131](https://github.com/hackforla/website/pull/2131) 

@ino-iosdev ino-iosdev added Feature Missing This label means that the issue needs to be linked to a precise feature label. size: 0.25pt Can be done in 0.5 to 1.5 hours ER Emergent Request role missing Complexity: Missing labels Jun 12, 2024

This comment was marked as outdated.

@t-will-gillis

This comment was marked as resolved.

@ExperimentsInHonesty ExperimentsInHonesty added Feature: Onboarding/Contributing.md and removed Feature Missing This label means that the issue needs to be linked to a precise feature label. labels Jun 23, 2024
@ExperimentsInHonesty ExperimentsInHonesty added the Draft Issue is still in the process of being created label Oct 6, 2024
@t-will-gillis t-will-gillis added role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers Complexity: Small Take this type of issues after the successful merge of your second good first issue size: 1pt Can be done in 4-6 hours and removed size: 0.25pt Can be done in 0.5 to 1.5 hours role missing Complexity: Missing labels Oct 6, 2024
@ExperimentsInHonesty ExperimentsInHonesty removed the Draft Issue is still in the process of being created label Oct 15, 2024
@DrAcula27 DrAcula27 self-assigned this Oct 18, 2024
@DrAcula27 DrAcula27 moved this from Prioritized backlog to In progress (actively working) in P: HfLA Website: Project Board Oct 18, 2024
@HackforLABot
Copy link
Contributor

Hi @DrAcula27, 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 :)

@DrAcula27
Copy link
Member

DrAcula27 commented Oct 18, 2024

Availability: weekdays after 3pm Pacific
ETA: 27 October 2024

@t-will-gillis t-will-gillis added the Issue Making: Level 2 Make issue(s) from an ER or Epic label Oct 21, 2024
@DrAcula27
Copy link
Member

@t-will-gillis The issue for this ER has been made.

Let me know if there are any questions/concerns!

@DrAcula27 DrAcula27 moved this from In progress (actively working) to Questions / In Review in P: HfLA Website: Project Board Oct 28, 2024
@DrAcula27 DrAcula27 added the ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization label Oct 28, 2024
@t-will-gillis t-will-gillis moved this from Questions / In Review to In progress (actively working) in P: HfLA Website: Project Board Oct 28, 2024
@t-will-gillis t-will-gillis removed the ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization label Oct 28, 2024
@t-will-gillis t-will-gillis moved this from In progress (actively working) to Questions / In Review in P: HfLA Website: Project Board Nov 15, 2024
@t-will-gillis
Copy link
Member

Closing this ER, issue #7641 has been made to address it

@github-project-automation github-project-automation bot moved this from Questions / In Review to QA in P: HfLA Website: Project Board Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue ER Emergent Request Feature: Onboarding/Contributing.md Issue Making: Level 2 Make issue(s) from an ER or Epic role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours
Development

No branches or pull requests

5 participants