Skip to content

docs: add PostgreSQL setup guide for Belinda’s Closet#48

Open
Bashir3355 wants to merge 2 commits into
SeattleColleges:mainfrom
Bashir3355:DocumentationPostgreSQL_issueNo1
Open

docs: add PostgreSQL setup guide for Belinda’s Closet#48
Bashir3355 wants to merge 2 commits into
SeattleColleges:mainfrom
Bashir3355:DocumentationPostgreSQL_issueNo1

Conversation

@Bashir3355

Copy link
Copy Markdown

Summary

This pull request adds documentation for setting up PostgreSQL for the Belinda’s Closet project.

The guide includes step-by-step instructions for:

  • Installing PostgreSQL
  • Creating the database
  • Setting up a user and permissions
  • Configuring the connection string

Changes Made

  • Added belindas-closet-postgresql-setup.md
  • Included clear and structured setup instructions
  • Ensured proper markdown formatting

Purpose

This documentation helps developers easily set up the required PostgreSQL environment for the project.

@josehorta21

Copy link
Copy Markdown

Reviewed the PostgreSQL setup guide for Belinda's Closet. The documentation
is well-structured — clear prerequisites section, step-by-step installation,
verification steps, and database creation commands are all easy to follow.

One observation: this PR includes two files in the diff —
Issue-Creation/Issue-Creation.md and belindas-closet-postgresql-setup.md.
The PR title and summary only reference the PostgreSQL setup guide, so it
might be worth either updating the PR description to mention both additions
or splitting them into separate PRs for cleaner review history.

Also noticed the two failing checks (Auto-assign PRs and Sync Project Status) —
might be worth checking if those are blocking the required reviews.

Content-wise, the PostgreSQL guide LGTM. Nice work on the formatting.

@Eric-Cashman

Copy link
Copy Markdown

Looks good! I loved the formatting, and the instructions are very clear. One question that I have is, is there any particular reason why the belindas-closet-postgresql-setup.md is outside the belindas-closet folder?

Looks good!

@DennizGarza1234

Copy link
Copy Markdown

Reviewed the pull request for the Belinda’s Closet PostgreSQL setup documentation.

The guide is well-structured and easy to follow. The instructions for installing PostgreSQL, creating the database, setting up users/permissions, and configuring the connection string are clearly written and organized in a logical step-by-step format.

The formatting in markdown is clean and makes the setup process accessible for new developers.

One small observation is that the PR includes multiple changes across different documentation files, not just the PostgreSQL setup guide. It may be helpful to clarify this in the PR title or split unrelated documentation updates into separate pull requests to improve review clarity.

There were also failing automated checks noted (Auto-assign PRs and Sync Project Status), which should be resolved to ensure smooth merging and proper project tracking.

Overall, the PostgreSQL setup documentation looks good and fulfills its purpose as a clear onboarding guide for developers setting up the environment.

@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.

Reviewed PR #48. The Issue Creation Guide is clear and well-structured, offering straightforward steps for new contributors. The Belinda's Closet PostgreSQL Setup Guide is detailed and beginner-friendly, with effective use of code blocks. One suggestion: in Step 2 of the PostgreSQL guide, avoid displaying the password field entirely — even as asterisks — and instead instruct users to enter their own password to avoid confusion. Overall, this is a helpful addition to the project documentation.

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