Skip to content

docs: add conventional commits guide#47

Open
Bashir3355 wants to merge 1 commit into
SeattleColleges:mainfrom
Bashir3355:issue-45-wiki-update
Open

docs: add conventional commits guide#47
Bashir3355 wants to merge 1 commit into
SeattleColleges:mainfrom
Bashir3355:issue-45-wiki-update

Conversation

@Bashir3355

@Bashir3355 Bashir3355 commented Mar 9, 2026

Copy link
Copy Markdown

Added documentation referencing Conventional Commits to the Practicum Wiki to guide students on writing standardized commit messages.

Includes:

  • Link to the official Conventional Commits specification
  • Explanation of why standardized commit messages are important
  • Examples of common commit types such as feat, fix, and docs

Fixes #45

@Bashir3355 Bashir3355 changed the title Add Issue Creation Guide Documentation (Fix #45) docs: add conventional commits guide Mar 9, 2026

@Bashir3355 Bashir3355 left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

documentation added and looks good.
Waiting for the approval to be completed or merged.

@DS-0277 DS-0277 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The description looks great. Good job!

@josehorta21

Copy link
Copy Markdown

Reviewed the PR. The Issue Creation Guide content itself is well-written —
clear purpose section, step-by-step instructions, and a useful Best Practices
section at the end.

However, I noticed a mismatch between the PR metadata and the actual file
changes: the PR title says "docs: add conventional commits guide" and the
description references Conventional Commits (with examples like feat, fix,
docs), but the only file added in this PR is Issue-Creation/Issue-Creation.md,
which is an Issue Creation guide — not a Conventional Commits guide.

Could you clarify whether:

  1. The Conventional Commits file was meant to be included but is missing, or
  2. The PR title and description should be updated to reflect that this adds
    the Issue Creation Guide instead?

Also noticed the failing checks (Auto-assign and Sync Project Status). Once
the title/content alignment is sorted out, this should be ready to go.

Content LGTM, just needs the metadata cleaned up.

@DennizGarza1234 DennizGarza1234 self-requested a review May 3, 2026 20:37
@DennizGarza1234

Copy link
Copy Markdown

Reviewed the PR. The documentation is well structured and easy to follow.

The setup steps are clear and logically ordered. Code changes align with the PR description and are easy to understand.

One suggestion: ensure that the PR title matches the exact content of the files being changed to avoid confusion during review.

Overall, this looks good and meets the expected requirements.

@ErmiyasHailemichael

Copy link
Copy Markdown

Good effort on this guide! A few things I noticed:

  • The PR title says "conventional commits guide" but the content is actually an Issue Creation guide — these don't match.
  • The wiki already has an Issue Creation page with more detail. This version is missing some sections like naming conventions and sprint assignment.
  • Small grammar fix needed: "Provide screenshots or examples this will be helpful" should be "Provide screenshots or examples if applicable."

Worth aligning with the existing wiki page before merging to avoid confusion.

@ErmiyasHailemichael ErmiyasHailemichael left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

  • The PR title says "conventional commits guide" but the content is actually an Issue Creation guide — these don't match.
  • The wiki already has an Issue Creation page with more detail. This version is missing some sections like naming conventions and sprint assignment.
  • Small grammar fix needed: "Provide screenshots or examples this will be helpful" should be "Provide screenshots or examples if applicable."

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.

Issue: Include Conventional Commits

5 participants