ci: run Markdown linter #68
Conversation
|
Warning Rate limit exceeded@zolotokrylin has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 22 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. 📒 Files selected for processing (4)
WalkthroughRepository documentation was reorganized: several policy and onboarding files were moved from Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (2)
.github/workflows/markdown_lint.yml (1)
16-26: Add error handling for external binary download.The workflow downloads a pre-compiled rumdl binary from an external GitHub repo without verification or error handling. If the download fails or extraction encounters an issue, the workflow silently continues (due to
-sflag in curl), potentially masking errors.Consider adding error handling and making the commands more robust:
- name: Install rumdl pre-compiled binary run: | # Define the URL for the latest Linux binary DOWNLOAD_URL="https://github.com/rvben/rumdl/releases/download/v0.0.181/rumdl-v0.0.181-x86_64-unknown-linux-gnu.tar.gz" # Use curl to download the archive and tar to extract it - curl -sL $DOWNLOAD_URL | tar -xz -C /usr/local/bin/ + set -e # Exit on first error + + # Download with verification + curl -fsSL "$DOWNLOAD_URL" | tar -xz -C /usr/local/bin/ # Ensure the binary is executable and in the PATH chmod +x /usr/local/bin/rumdl + + # Verify installation + /usr/local/bin/rumdl --versionKey improvements:
set -e: Exit immediately if any command fails-f(fail on HTTP errors) in curl: stop on download failure--versioncheck: confirms binary is executable and installed- Double quotes around variables: safer variable expansion
docs/APPLICATION_SUCCESS.md (1)
26-33: Optional: Reduce repetition of "right" for better prose clarity.The word "right" appears twice in close proximity (lines 27 and 29), which slightly weakens the prose. While not a blocking issue, consider varying the language for improved readability.
Suggested revision:
It's all about the team culture that we care about. Part of this team culture is the individual ability to figure things out, provide the right solutions, -display initiative, be honest and transparent, take responsibility, care for -details, ability to make the right calls, and much more. +display initiative, be honest and transparent, take responsibility, care for +details, sound judgment, and much more.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
docs/private-thread-instruction-min.pngis excluded by!**/*.pngpackage-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (15)
.github/APPLICATION_SUCCESS.md(0 hunks).github/CODE_OF_CONDUCT.md(0 hunks).github/LEAVE_POLICY.md(0 hunks).github/TRIAL.md(0 hunks).github/workflows/markdown_lint.yml(1 hunks).rumdl.toml(1 hunks)README.md(1 hunks)docs/ADVOCACY.md(3 hunks)docs/APPLICATION_SUCCESS.md(1 hunks)docs/CODE_OF_CONDUCT.md(1 hunks)docs/COMPENSATION.md(1 hunks)docs/CONTRIBUTING.md(8 hunks)docs/LEAVE_POLICY.md(1 hunks)docs/PRINCIPLES.md(2 hunks)docs/TRIAL.md(1 hunks)
💤 Files with no reviewable changes (4)
- .github/APPLICATION_SUCCESS.md
- .github/CODE_OF_CONDUCT.md
- .github/TRIAL.md
- .github/LEAVE_POLICY.md
🧰 Additional context used
🪛 LanguageTool
docs/TRIAL.md
[style] ~14-~14: Generally speaking, “themself” is only acceptable when referring to a singular entity (such as the singular usage of “they”, which is the preferred pronoun for many non-binary people). If “themself” refers to a plural entity (such as “everybody”, or the standard usage of “they”), you should use “themselves”.
Context: ...ving the Goal 1. every engineer assigns themself one Problem at a time and proposes a so...
(THEMSELF)
docs/CODE_OF_CONDUCT.md
[style] ~28-~28: To elevate your writing, try using more descriptive phrasing here.
Context: ...hieve our team goals, ask, “What is our biggest obstacle?” and focus on the next acti...
(BIGGEST_CHALLENGE)
docs/ADVOCACY.md
[style] ~30-~30: This phrase may be considered too wordy. Consider using “while” instead.
Context: ...io You must exclusively promote Holdex during the period you being under Holdex contract, you sh...
(DURING_THE_PERIOD)
docs/APPLICATION_SUCCESS.md
[style] ~29-~29: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ..., care for details, ability to make the right calls, and much more. All of which can'...
(REP_RIGHT)
🔇 Additional comments (8)
docs/COMPENSATION.md (1)
3-12: Markdown formatting changes align with linter configuration.The reflow and list numbering comply with the new rumdl rules (MD013 line-length, MD029 style="one"). Content semantics are preserved.
docs/PRINCIPLES.md (1)
10-23: List numbering updated to MD029 "one" style.The sequential numbering (1, 2, 3, 4, 5) converted to all "1." complies with the new rumdl configuration (
MD029 style = "one"). This style improves maintainability by avoiding renumbering when items are reordered.docs/ADVOCACY.md (1)
3-46: Formatting changes align with linter configuration.The reflow and restructuring of lines comply with MD013 (line-length=80, reflow=true). Content organization is preserved.
docs/CODE_OF_CONDUCT.md (1)
1-31: New Code of Conduct file is well-structured and linter-compliant.List numbering uses "1." for all items (MD029 style="one"), and the core values section is clearly organized. The content is accessible and sets expectations appropriately.
docs/CONTRIBUTING.md (1)
3-292: Comprehensive reflow complies with MD013 line-length rules.Extensive line wrapping across all sections aligns with the linter configuration (line-length=80, reflow=true). Content semantics, structure, and internal references remain intact. This is a quality improvement for documentation readability and consistency.
.rumdl.toml (1)
1-75: Linter configuration is well-structured and appropriately configured.The rumdl configuration:
- Excludes common build/vendor directories appropriately
- Enforces MD013 (80-char line-length) with reflow enabled, explaining documentation reformatting
- Enforces MD029 (MD029 style="one"), explaining list numbering changes throughout docs
- Exempts code blocks and tables from line-length checks (best practice)
- Allows HTML details/summary elements, a modern Markdown pattern
- Includes helpful commented examples for future customization
The configuration aligns well with the documentation changes observed in this PR.
.github/workflows/markdown_lint.yml (1)
3-14: Workflow triggers and PR conditions are appropriate.The workflow correctly:
- Triggers on pushes to main and PR events (opened, reopened, synchronize, ready_for_review)
- Skips draft PRs using the condition on line 14 (
!github.event.pull_request.draft)- Runs on ubuntu-latest with sufficient permissions
docs/LEAVE_POLICY.md (1)
1-64: Leave policy documentation is well-organized and clearly written.The new policy file:
- Clearly defines key terms (Year of Service, Minimum Service Period)
- Outlines the leave request process with specific timelines
- Provides formulas for leave compensation using proper code block formatting
- Uses blockquote callouts for important notes and caveats
- Specifies concrete leave allowances (14 days paid, 3-day carryover, etc.)
The structure and level of detail are appropriate for policy documentation.
Time Submission Status
|
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Vadim <vadim@holdex.io>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Vadim <vadim@holdex.io>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/TRIAL.md (1)
36-36: Critical: Image link still references the wrong directory.Per the previous review, the image link on line 36 continues to point to
.github/private-thread-instruction-min.png, but the file is located atdocs/private-thread-instruction-min.png(in the same directory as this file). Update the link to the correct relative path.- [PRIVATE THREAD](https://github.com/holdex/developers/blob/main/.github/private-thread-instruction-min.png) + [PRIVATE THREAD](./private-thread-instruction-min.png)Alternatively, use the absolute GitHub URL:
- [PRIVATE THREAD](https://github.com/holdex/developers/blob/main/.github/private-thread-instruction-min.png) + [PRIVATE THREAD](https://github.com/holdex/developers/blob/main/docs/private-thread-instruction-min.png)docs/ADVOCACY.md (1)
30-32: Fix grammatically incorrect phrase (previously flagged).The phrase "during the period you being under Holdex contract" is grammatically incorrect and was flagged in a prior review. This remains unresolved. Use "while you are under Holdex contract" or the more concise "while under Holdex contract" instead.
-You must exclusively promote Holdex during the period you being under Holdex -contract, you should not include any mentions of other brands or any links other -than Holdex-related links. +You must exclusively promote Holdex while under Holdex contract. Do not include +mentions of other brands or links other than Holdex-related ones.
🧹 Nitpick comments (2)
docs/TRIAL.md (1)
14-15: Address Markdown line length violations (MD013).The static analysis identified two lines exceeding the 80-character limit:
- Lines 14–15: 101 characters (list item with inline link)
- Lines 33–34: 123 characters (list item with inline link)
Since this PR adds a Markdown linter to CI, reflow or reorganize these lines to comply with the linter. Consider breaking long lines or using reference-style links.
Example refactor for lines 33–34:
-1. Align yourself with our [Developer Guidelines](./CONTRIBUTING.md). Not - following them will result in your contribution being rejected. +1. Align yourself with our [Developer Guidelines][dev-guidelines]. + Not following them will result in your contribution being rejected. + +[dev-guidelines]: ./CONTRIBUTING.mdOr, if using reference-style links, define them at the end of the file.
Also applies to: 33-34
docs/CONTRIBUTING.md (1)
293-295: Consider alternative phrasing for "free time".The phrase "free time" is flagged as overused. Consider rephrasing for stronger writing.
-If you ever have free time, be proactive and apply the scout approach: own the job, look for PRs that still need reviewers, and offer timely feedback so work keeps moving. +If you have availability, be proactive and apply the scout approach: own the job, look for PRs that still need reviewers, and offer timely feedback so work keeps moving.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
README.md(1 hunks)docs/ADVOCACY.md(4 hunks)docs/CONTRIBUTING.md(8 hunks)docs/TRIAL.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- README.md
🧰 Additional context used
🪛 GitHub Check: lint
docs/TRIAL.md
[warning] 33-34: MD013
Line length 123 exceeds 80 characters
[warning] 14-15: MD013
Line length 101 exceeds 80 characters
docs/CONTRIBUTING.md
[warning] 50-51: MD013
Line length 107 exceeds 80 characters
[warning] 139-140: MD013
Paragraph could be normalized to use line length of 80 characters
[warning] 150-152: MD013
Paragraph could be normalized to use line length of 80 characters
[warning] 257-258: MD013
Paragraph could be normalized to use line length of 80 characters
🪛 LanguageTool
docs/ADVOCACY.md
[style] ~30-~30: This phrase may be considered too wordy. Consider using “while” instead.
Context: ...io You must exclusively promote Holdex during the period you being under Holdex contract, you sh...
(DURING_THE_PERIOD)
docs/CONTRIBUTING.md
[style] ~295-~295: The word “free” tends to be overused. Consider using an alternative wording to strengthen your writing.
Context: ... ### Scout approach If you ever have free time, be proactive and apply the scout appro...
(FREE_TIME)
🔇 Additional comments (1)
docs/TRIAL.md (1)
14-14: ✓ Grammar issue resolved.The previous review flagged the use of "themself" in plural context. This has been corrected to "themselves," which is grammatically correct.
Resolves: https://github.com/holdex/hr-member-angelica-w/issues/11
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.