Skip to content

ci: handle documentation-only repos in desloppify gate #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samtuckerdavis merged 2 commits into from
May 3, 2026
Merged

ci: handle documentation-only repos in desloppify gate #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf23375
ci: handle documentation-only repos in desloppify gate
samtuckerdavis May 3, 2026
37c5fb5
fix: remove speciesist terms from meta-instruction text
samtuckerdavis May 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .coderabbit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ reviews:
instructions: |
Check for: speciesist language, factual accuracy about animal advocacy, correct movement terminology.
Verify: campaign/investigation/coalition/farmed animal/factory farm/slaughterhouse used precisely.
No industry euphemisms ('livestock', 'production facility', 'farm').
No industry euphemisms (use 'farmed animals' not industry terms; use 'factory farm' not 'farm').

pre_merge_checks:
custom_checks:
- name: "No speciesist idioms"
mode: "error"
instructions: |
Fail if docs contain speciesist idioms:
'livestock' -> 'farmed animals', 'master/slave' -> 'primary/replica',
'whitelist/blacklist' -> 'allowlist/denylist', 'kill two birds' -> 'accomplish two things at once',
'guinea pig' -> 'test subject', 'farm' (industry euphemism) -> 'factory farm'.
Fail if docs contain speciesist idioms as defined in
https://github.com/Open-Paws/no-animal-violence — use inclusive alternatives
(e.g., 'farmed animals', 'primary/replica', 'allowlist/denylist',
'accomplish two things at once', 'test subject', 'factory farm').
- name: "No hardcoded secrets or credentials"
mode: "error"
instructions: "Fail if any file contains hardcoded API keys, tokens, or credentials."
Expand Down
10 changes: 10 additions & 0 deletions .github/workflows/desloppify.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,16 @@ jobs:
exit 1
fi
echo "Objective score: ${SCORE}/100"
# When there are no recognized code files (documentation-only repos),
# desloppify returns 0.0 because there is nothing to measure, not
# because the code is bad. Detect this via empty Zones output and
# treat it as a full pass rather than a false failure.
ZONES=$(echo "${SCAN_OUTPUT}" | grep -oP '(?<=Zones: ).*' | head -1)
if [ -z "${ZONES}" ] && python3 -c "import sys; sys.exit(0 if float('${SCORE}') == 0.0 else 1)"; then
echo "No code files detected in any zone - documentation-only repository."
echo "Gate passes: 0.0 score reflects an empty scan, not poor quality."
SCORE="100.0"
fi
python3 -c "
score = float('${SCORE}')
threshold = 70
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ Write in plain, direct prose. First-person plural ("we") is appropriate when des

**Use movement terminology.** This documentation exists to help developers build tools for animal liberation. Use precise advocacy language:

- **Farmed animal** — not "livestock" (industry framing)
- **Farmed animal** — not the industry term (use movement language, not production framing)
- **Factory farm** — not "farm" or "production facility"
- **Campaign** — an organized advocacy effort with defined goals
- **Investigation** — covert documentation (all data is potential evidence)
- **Sanctuary** — permanent care facility, not "shelter"
Comment on lines +42 to 46
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 3, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use the repo’s exact movement term here.

Farmed animal is singular, but the repo guidance uses farmed animals. Keeping the established wording avoids terminology drift in contributor docs. As per coding guidelines, use 'farmed animals' not industry terms; use 'factory farm' not 'farm'.

Suggested edit 
-- **Farmed animal** — not the industry term (use movement language, not production framing)
+- **Farmed animals** — not the industry term (use movement language, not production framing)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **Farmed animal** — not the industry term (use movement language, not production framing)
- **Factory farm** — not "farm" or "production facility"
- **Campaign** — an organized advocacy effort with defined goals
- **Investigation** — covert documentation (all data is potential evidence)
- **Sanctuary** — permanent care facility, not "shelter"
- **Farmed animals** — not the industry term (use movement language, not production framing)
- **Factory farm** — not "farm" or "production facility"
- **Campaign** — an organized advocacy effort with defined goals
- **Investigation** — covert documentation (all data is potential evidence)
- **Sanctuary** — permanent care facility, not "shelter"
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` around lines 42 - 46, Replace the singular header/term
"Farmed animal" in CONTRIBUTING.md with the repo's canonical plural phrase
"farmed animals" (matching casing/spacing used elsewhere) so contributor
guidance stays consistent; search for the exact string "Farmed animal" and
update it to "farmed animals", and verify the other entries (e.g., "Factory
farm") remain unchanged and aligned with the repo terminology.


The full language guide and automated enforcement tools are at [github.com/Open-Paws/no-animal-violence](https://github.com/Open-Paws/no-animal-violence). The pre-commit hook runs on every commit — if it flags something, fix it rather than bypassing it.

**No speciesist idioms.** Avoid idioms that normalize animal violence. Common ones to watch for: "kill two birds with one stone" (use "accomplish two things at once"), "guinea pig" as a test-subject metaphor (use "test subject"), "cattle vs. pets" distinctions (use "ephemeral vs. persistent").
**No speciesist idioms.** Avoid idioms that normalize animal violence. The full rule set is at [Open-Paws/no-animal-violence](https://github.com/Open-Paws/no-animal-violence). Use inclusive alternatives: "accomplish two things at once", "test subject", "ephemeral vs. persistent".

## Referencing Open Paws tools and APIs

Expand Down
Loading