chore: README and CONTRIBUTING updates

[ymc9]

No description provided.

[coderabbitai]

Warning

Rate limit exceeded

@ymc9 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 3 minutes and 7 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between cc952b1 and 6ecd6e4.

📒 Files selected for processing (2)

• CONTRIBUTING.md
• README.md

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/docs-update

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[claude]

Claude finished @ymc9's task —— View job

---

Pull Request Review ✅

Reviewed this documentation update PR with focus on code quality, potential issues, performance, security, and test coverage.

Todo List:

• Read and analyze CONTRIBUTING.md changes
• Read and analyze README.md changes
• Evaluate code quality and best practices
• Check for potential bugs or issues
• Assess performance considerations
• Review security concerns
• Evaluate test coverage implications
• Provide comprehensive feedback

Changes Identified:

1. CONTRIBUTING.md: Fixed PostgreSQL connection string format (removed extra $ at the end)
2. README.md: Fixed broken link to ZenStack V2 documentation

---

Review Findings

✅ Code Quality and Best Practices

These are clean documentation fixes that follow good practices:

• CONTRIBUTING.md:14: Corrected PostgreSQL connection string format from postgresql://${TEST_PG_USER}:${TEST_PG_PASSWORD}$@${TEST_PG_HOST}$:${TEST_PG_PORT}$ to postgresql://${TEST_PG_USER}:${TEST_PG_PASSWORD}$@${TEST_PG_HOST}$:${TEST_PG_PORT} - removes erroneous trailing $
• README.md:40: Fixed broken link from https://github.com/zenstackhq/zenstack/docs/2.x to https://github.com/zenstackhq/zenstack - the old link structure was incorrect

✅ Potential Bugs or Issues

Fixed Issues:

• The PostgreSQL connection string in CONTRIBUTING.md had an invalid format that would cause connection failures
• The V2 documentation link was broken and would result in a 404 error

No New Issues: These changes only fix existing problems without introducing any new issues.

✅ Performance Considerations

Not Applicable: These are documentation-only changes with no runtime impact.

✅ Security Concerns

No Security Impact: Both changes are purely documentation updates that don't affect security:

• The PostgreSQL connection string fix doesn't expose credentials (still uses environment variables)
• The link correction doesn't introduce any security vulnerabilities

✅ Test Coverage

Not Applicable: Documentation changes don't require test coverage. However, it would be beneficial to:

• Verify the corrected PostgreSQL connection string works in development setup
• Confirm the updated V2 link resolves correctly

Recommendation

APPROVE - These are necessary documentation fixes that improve developer experience:

1. Developers can now successfully connect to PostgreSQL using the corrected connection string
2. Users can access the V2 documentation through the fixed link

The changes are minimal, safe, and address real issues in the documentation.

---

[Copilot]

Pull request overview

This PR addresses documentation corrections in README and CONTRIBUTING files, fixing a malformed GitHub URL and partially correcting a PostgreSQL connection string format.

• Fixed incorrect V2 documentation link in README.md
• Partially corrected PostgreSQL connection string syntax in CONTRIBUTING.md

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
README.md	Corrected malformed GitHub repository URL for V2 documentation link
CONTRIBUTING.md	Removed trailing dollar sign from PostgreSQL connection string (partial fix)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The connection string still contains extra dollar signs after the environment variable placeholders. The $ characters after ${TEST_PG_PASSWORD} and ${TEST_PG_HOST} should be removed as they are not part of standard shell variable syntax and would be interpreted as literal characters in the connection string.

Suggested change

	`postgresql://${TEST_PG_USER}:${TEST_PG_PASSWORD}$@${TEST_PG_HOST}$:${TEST_PG_PORT}`
	`postgresql://${TEST_PG_USER}:${TEST_PG_PASSWORD}@${TEST_PG_HOST}:${TEST_PG_PORT}`