Skip to content

[Repo Health] documentation: FTR fixes#10

Merged
stuckvgn merged 3 commits intomainfrom
health/ftr/documentation
Apr 2, 2026
Merged

[Repo Health] documentation: FTR fixes#10
stuckvgn merged 3 commits intomainfrom
health/ftr/documentation

Conversation

@stuckvgn
Copy link
Copy Markdown
Contributor

@stuckvgn stuckvgn commented Apr 2, 2026

Summary

  • Adds CONTRIBUTING.md — the repo had no contributor guide, leaving content standards, file naming, writing style, and PR workflow undocumented

What was added

CONTRIBUTING.md covers:

  • What content belongs in this repo (docs, examples, integration guides) and what does not (application code, duplicated content)
  • Directory structure reference
  • File naming conventions (lowercase-hyphenated)
  • Writing style guidelines: plain prose, self-contained sections, copy-pasteable examples
  • Advocacy language requirements with movement terminology and a link to the no-animal-violence guide
  • API/service documentation standards (auth via env vars, minimal examples before advanced usage, no hardcoded credentials)
  • PR guidelines: one topic per PR, under 200 lines, run language check locally before pushing
  • Quality gate: desloppify minimum score of 85

What was not added

  • Dockerfile — this is a pure docs repo with no runnable code; a Dockerfile would be inappropriate
  • LICENSE — already present (MIT, Open Paws, 2025)

Test plan

  • CONTRIBUTING.md renders correctly on GitHub
  • All links in CONTRIBUTING.md resolve (no-animal-violence, desloppify)
  • Language check passes: semgrep --config semgrep-no-animal-violence.yaml CONTRIBUTING.md

stuckvgn added 3 commits April 2, 2026 22:05
Adds .pre-commit-config.yaml with markdownlint-cli hook for .md files.
Excludes .claude/ (agent instruction files from other repos).
Disables MD013/MD033/MD041 (line length, inline HTML, first-line heading).
Adds .desloppify/ to .gitignore.
Adds contributor guide covering what content belongs in the repo,
directory structure, file naming conventions, writing style, advocacy
language requirements, API documentation standards, PR guidelines,
and the desloppify quality gate.
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 2, 2026

Warning

Rate limit exceeded

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

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 6 minutes and 34 seconds.

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 168d00b7-6c83-468b-85ae-cc180f62978d

📥 Commits

Reviewing files that changed from the base of the PR and between fb8158e and d502eb7.

📒 Files selected for processing (4)
  • .gitignore
  • .pre-commit-config.yaml
  • CLAUDE.md
  • CONTRIBUTING.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch health/ftr/documentation

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

@stuckvgn stuckvgn merged commit ded0858 into main Apr 2, 2026
2 checks passed
@stuckvgn stuckvgn deleted the health/ftr/documentation branch April 2, 2026 17:47
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.

1 participant