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

Improve checklist structure #18

Merged
merged 19 commits into from
Jan 25, 2024
Merged

Conversation

SidestreamColdMelon
Copy link
Contributor

This PR addresses issues related to the structure of the checklist (as opposed to the content of it) discovered during onboarding of the new spell team members. Main problems we've discovered together with the solutions:

  • Unclear differentiation between items that are not present and can be skipped and items that are not present, but have to be present
    • Solution: Introduce concept of branching using uppercase IF
  • Unclear differentiation between the actual actionable and a category, explanation, option
    • Solution: Remove checkboxes from everywhere except the actual checks
  • Confusing order of operations (first Exec Doc check is done before Exec Doc link is determined)
    • Solution: Rearrange checks in the order that does not confuse reviewer or leave a room for a mistake

Copy link
Contributor

@amusingaxl amusingaxl left a comment

Choose a reason for hiding this comment

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

Good stuff! 💯

I believe this structure is an improvement, specially the introduction of branching.

I made a couple of suggestions, let me know what you think.

Copy link
Contributor

@amusingaxl amusingaxl left a comment

Choose a reason for hiding this comment

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

LGTM!

Thanks for putting in the effort!

Copy link
Contributor

@amusingaxl amusingaxl left a comment

Choose a reason for hiding this comment

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

:shipit: LGTM

@SidestreamColdMelon SidestreamColdMelon merged commit 1049ef1 into master Jan 25, 2024
2 checks passed
@SidestreamColdMelon SidestreamColdMelon deleted the improve-checklist-structure branch January 25, 2024 15:31
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.

3 participants