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

Update engineering_spike.md #90

Closed
wants to merge 2 commits into from
Closed

Conversation

eileenruberto
Copy link
Collaborator

@eileenruberto eileenruberto commented Apr 18, 2024

Pull Request

Description

Added sections to the existing template based on Research Spike Template Proposal

Related Issues

N/A

Additional Notes

N/A

Checklist

Please review and complete the following checklist before submitting your pull request:

  • I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
  • I have reviewed my changes to ensure they are clear, concise, and well-documented.
  • I have updated the documentation, if applicable.
  • I have added or updated test cases to cover my changes, if applicable.
  • I have minimized the number of reviewers to include only those essential for the review.
  • I have notified teammates in the review thread to build awareness.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

  • The code follows best practices and conventions.
  • The changes implement the desired functionality or fix the reported issue.
  • The tests cover the new changes and pass successfully.
  • Any potential edge cases or error scenarios have been considered.

Added sections to the existing template based on Research Spike Template draft
bryanbritten
bryanbritten previously approved these changes Apr 18, 2024
Copy link
Collaborator

@bryanbritten bryanbritten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pirate-pirate-ship (1)

@derekadombek derekadombek self-requested a review April 19, 2024 14:24
@@ -7,11 +7,40 @@ assignees: ''

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Above on line 5, the label is currently set with the OCR label. So ATM(im pretty sure) this will only apply to issues being made for the OCR board, we probably could just add the dedupe label and it should work for both.

Copy link
Collaborator

@derekadombek derekadombek Apr 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be best to replace whats currently in the idwa_dedupe.yml with this new one?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@derekadombek I've removed the OCR label per @bryanbritten's suggestion in Slack:

FWIW I would prefer minimizing the number of "team-specific" resources that we use. The Research Spike Template is a good example of something that could be used across both teams, and would create consistency in how we track the work we're doing. My recommendation would be to simply remove the OCR label and request that any one creating a research spike ticket manually add the label for their team, and then the GH Action that Derek set up will take care of assigning it to the appropriate project.

Removed the `OCR` label from template so this can be used across both IDWA teams
@derekadombek derekadombek self-requested a review April 23, 2024 13:31
Copy link
Collaborator

@cbrinson-rise8 cbrinson-rise8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Copy link
Collaborator

@zdeveloper zdeveloper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, as the person who has been the biggest user of the engineering spike template, I am not the biggest fan of the verbosity of this template, but I will probably end up removing some of the non-relevant sections.

@zdeveloper
Copy link
Collaborator

closing this since its been open for too long

@zdeveloper zdeveloper closed this Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants