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 Retrospective.md #101

Merged
merged 3 commits into from
Jan 12, 2025
Merged

Update Retrospective.md #101

merged 3 commits into from
Jan 12, 2025

Conversation

mojtabafayyaz
Copy link

@mojtabafayyaz mojtabafayyaz commented Jan 12, 2025

Review Checklist for Retrospective

This checklist helps ensure that the PR review process is thorough and consistent. Reviewers should focus on clarity,
content quality, actionability, and adherence to best practices. Please follow the points below while reviewing the PR.

Structure and Formatting

  • Template Compliance: Ensure the correct template is used (Stop Doing, Continue Doing, etc.).
  • Markdown Syntax: Check if headings, bullet points, and line breaks follow proper Markdown syntax.

Content Quality

  • Relevance: Verify that all points are relevant, clear, and actionable.
  • Comprehensiveness: Confirm that the "Lessons Learned" and "Strategy vs. Board" sections are thoughtful and complete.

Clarity and Simplicity

  • Conciseness: Sentences should be concise, easy to read, and conversational.
  • Avoid Ambiguity: Ensure there is no jargon or ambiguous language.

Actionability and Best Practices

  • Actionable Start Doing: Review whether the suggestions in "Start Doing" are practical and specific.
  • Git Best Practices: Ensure that Git best practices (like git mv, staging files) are correctly referenced.

Grammar and Consistency

  • Grammar Check: Look for any grammar, punctuation, or spelling errors.
  • Consistency: Ensure verb tenses and style are consistent throughout the document.

@mojtabafayyaz mojtabafayyaz added the documentation Improvements or additions to documentation label Jan 12, 2025
@mojtabafayyaz mojtabafayyaz self-assigned this Jan 12, 2025
@MadiMalik MadiMalik self-requested a review January 12, 2025 16:48
@MadiMalik
Copy link

Everything is great; just add emojis in front of each header to make it more visually appealing

Copy link

@fatima-malik99 fatima-malik99 left a comment

Choose a reason for hiding this comment

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

All good Fayyaz, we will make sure to not to repeat these mistakes in our main project.

@fatima-malik99 fatima-malik99 linked an issue Jan 12, 2025 that may be closed by this pull request
@fatima-malik99 fatima-malik99 merged commit ba38f19 into main Jan 12, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Retrospective
3 participants