add error and steps

[kpj2006]

Addressed Issues:

Fixes #(issue number)

Screenshots/Recordings:

Additional Notes:

error handling

Checklist

• My code follows the project's code style and conventions
• I have made corresponding changes to the documentation
• My changes generate no new warnings or errors
• I have joined the Discord server and I will share a link to this PR with the project maintainers there
• I have read the Contributing Guidelines

⚠️ AI Notice - Important!

We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact.

Summary by CodeRabbit

• Documentation
  • Enhanced contributing documentation with a new comprehensive section on debugging pre-commit hooks, covering setup, common errors, solutions, and bypass procedures.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

@kpj2006 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 15 minutes and 48 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 41cba8a and 34e3674.

📒 Files selected for processing (1)

• CONTRIBUTING.md

📝 Walkthrough

Walkthrough

The CONTRIBUTING.md file was updated to include comprehensive documentation on debugging pre-commit hooks. A new Table of Contents entry was added, followed by a detailed section covering setup, common errors, troubleshooting solutions, bypassing hooks, running, updating, and help resources.

Changes

Cohort / File(s)	Summary
Documentation Updates CONTRIBUTING.md	Added TOC navigation entry and new "Debugging Pre-commit Hooks" section with guidance on setup, diagnosing common errors, implementing solutions, bypassing hooks, execution, updates, and help resources

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

documentation, no-issue-linked, size/S

Suggested reviewers

• Zahnentferner

Poem

🐰 Hops through the docs with glee so bright,
Pre-commit hooks now debug just right,
With errors caught and solutions clear,
Contributing just got a cheer! ✨

Pre-merge checks

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title is vague and generic, using non-descriptive terms that don't convey meaningful information about the specific changes made to the codebase.	Provide a more descriptive title that clearly indicates the main change, such as 'Add debugging guide for pre-commit hooks' or 'Document pre-commit hook errors and troubleshooting steps'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

CONTRIBUTING.md (2)

25-25: Verify the TOC link target matches the actual heading anchor.

The TOC entry references #debugging-pre-commit-hooks (line 25), but the heading includes an emoji prefix ## 🔧 Debugging Pre-commit Hooks (line 229). Depending on the markdown renderer, the emoji may cause the auto-generated anchor ID to differ, breaking the link.

Suggested fix: Either remove the emoji from the heading or update the link to match the actual anchor. Most markdown renderers strip emojis, so the link should work, but this is environment-dependent.

Also applies to: 229-229

---

486-486: Use more formal language in the closing statement.

Line 486 uses informal language: "Don't fight them - fix the issues they find!" For consistency with the formal documentation style elsewhere in the file, consider a more formal phrasing such as: "Work with pre-commit hooks to maintain code quality by addressing the issues they identify."

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 81c305f and 41cba8a.

📒 Files selected for processing (1)

• CONTRIBUTING.md

🧰 Additional context used

🧠 Learnings (2)

📚 Learning: 2025-12-28T01:17:41.264Z

Learnt from: kpj2006
Repo: AOSSIE-Org/Template-Repo PR: 13
File: .pre-commit-config.yaml:38-47
Timestamp: 2025-12-28T01:17:41.264Z
Learning: In the Template-Repo repository, the detect-secrets pre-commit hook should be commented out because this is a template repo, and secrets baselines are project-specific and shouldn't be included in templates.

Applied to files:

• CONTRIBUTING.md

📚 Learning: 2025-12-28T01:11:02.488Z

Learnt from: kpj2006
Repo: AOSSIE-Org/Template-Repo PR: 13
File: .pre-commit-config.yaml:18-27
Timestamp: 2025-12-28T01:11:02.488Z
Learning: In the Template-Repo repository, pre-commit-hooks should be pinned to known-stable versions rather than updated to the latest release, as the maintainer prefers version stability over bleeding-edge updates.

Applied to files:

• CONTRIBUTING.md

🪛 LanguageTool

CONTRIBUTING.md

[style] ~486-~486: Consider using a different verb for a more formal wording.
Context: ...intain code quality. Don't fight them - fix the issues they find! ## 🌟 Community ...

(FIX_RESOLVE)

🪛 markdownlint-cli2 (0.18.1)

CONTRIBUTING.md

25-25: Link fragments should be valid

(MD051, link-fragments)

---

247-247: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

264-264: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

281-281: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

302-302: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

327-327: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

344-344: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

370-370: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

422-422: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (2)

CONTRIBUTING.md (2)

229-486: Excellent addition to contributor documentation.

The new "Debugging Pre-commit Hooks" section is well-structured and comprehensive. The 10 error scenarios with clear solutions provide strong guidance for contributors. The section covers setup, common pitfalls, manual execution, and emergency procedures—all valuable for first-time contributors unfamiliar with pre-commit.

Key strengths:

• Clear error message + solution pattern for each scenario
• Actionable bash commands with explanations
• Links to external documentation and Discord support
• Addresses both automated fixes and manual intervention cases

Address the issues flagged in other comments (code fence language specifiers, detect-secrets alignment with template design, and tone formality) to complete this contribution.

---

299-322: The detect-secrets hook is currently enabled in .pre-commit-config.yaml (not commented out), making the troubleshooting guidance in CONTRIBUTING.md (lines 299-322) appropriate for the actual repository state. The section correctly advises users on handling detect-secrets failures and generating baseline files when needed. No changes are required.

Likely an incorrect or invalid review comment.