feat(docs): address failed CI checks before PR review requests #54
Conversation
WalkthroughThe pull request introduces several formatting adjustments and a new section on Continuous Integration (CI) checks in the Changes
Assessment against linked issues
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
.github/CONTRIBUTING.md (6)
1-2: Consider removing or clarifying the HTML comment.The HTML comment
<!-- pr init -->seems out of place and its purpose is unclear. Consider either removing it or adding a clear explanation of its purpose.
13-16: Consider using sequential numbers for better readability.While Markdown will render the list correctly with all "1." prefixes, using sequential numbers (1, 2, 3) improves readability in the source file.
-1. **Goal** – a business aim -1. **Problem** – an issue that is on our way to achieving the Goal -1. **Solution** – the actual deliverable which resolves the problem +1. **Goal** – a business aim +2. **Problem** – an issue that is on our way to achieving the Goal +3. **Solution** – the actual deliverable which resolves the problem
102-108: Add language identifier to the code block.The fenced code block should specify a language identifier for proper syntax highlighting.
-``` +```markdown ## Feature - [/page](https://figma.com/your-design-file-url) - ./page/{params} - (group) - [[state]](https://figma.com/your-design-file-url)<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint (0.37.0)</summary> 102-102: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> --- `121-127`: **Add language identifier to the example code block.** The example code block should specify a language identifier for proper syntax highlighting. ```diff -``` +```markdown ## Credit Vaults - [/lending](https://figma.com/your-design-file-url) - ./vaults/{poolAddr} - (Auction) - [[Withdraw Popup]](https://figma.com/your-design-file-url) - [[Bid Popup]](https://figma.com/your-design-file-url)<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint (0.37.0)</summary> 121-121: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> --- `157-161`: **Consider restructuring the time reporting section for better visibility.** The information about time allocation (40% planning, 20-30% QA) is crucial for contributors. Consider making this more prominent by: 1. Adding a dedicated "Time Reporting" subsection 2. Using a table or bullet points to break down the time allocation ```diff ## Requesting Review Once your PR is ready, assign reviewers and mark it as "ready to review." But before that, report the time you have spent on it. +### Time Reporting Guidelines + > [!NOTE] > When contributing, it's essential to report time accurately, including all stages of development (planning, implementation, QA). We encourage opening a PR at the start of your work, even during the planning or investigation phase. Programming and designing isn't just about writing code or creating designs; it also involves planning (40%) and QA (20-30%). + +Typical time allocation: +- Planning and Investigation: 40% +- Implementation: 30-40% +- Quality Assurance: 20-30%🧰 Tools
🪛 LanguageTool
[style] ~160-~160: Using many exclamation marks might seem excessive (in this case: 9 exclamation marks for a text that’s 6524 characters long)
Context: ...port the time you have spent on it. > [!NOTE] > When contributing, it's essentia...(EN_EXCESSIVE_EXCLAMATION)
110-111: Remove trailing punctuation from heading.According to markdown best practices, headings should not end with punctuation marks.
-#### Key: +#### Key🧰 Tools
🪛 Markdownlint (0.37.0)
110-110: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/CONTRIBUTING.md(8 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
.github/CONTRIBUTING.md
110-110: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
102-102: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
121-121: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🪛 LanguageTool
.github/CONTRIBUTING.md
[style] ~160-~160: Using many exclamation marks might seem excessive (in this case: 9 exclamation marks for a text that’s 6524 characters long)
Context: ...port the time you have spent on it. > [!NOTE] > When contributing, it's essentia...
(EN_EXCESSIVE_EXCLAMATION)
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)
Line range hint
1-170: Overall, the contribution guidelines are well-structured and comprehensive.The document effectively communicates the contribution process, from understanding goals to submitting PRs. The changes improve readability while maintaining the essential guidance for contributors.
🧰 Tools
🪛 Markdownlint (0.37.0)
110-110: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
102-102: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
.github/CONTRIBUTING.md (3)
81-93: Consider enhancing the CI Checks section with documentation links.The new CI Checks section is well-structured, but could be more helpful for new contributors by:
- Adding links to documentation for each CI check tool
- Providing more details about the "code-rabbit" validator and its quality standards
The required checks are as follows: -- The pr-time-tracker verifies that the time spent on the PR has been properly logged. -- The pr-time-tracker for bugs ensures that bug-related time tracking is correctly linked to the corresponding commit and bug author. -- The code-rabbit validates that the code meets quality standards and passes all automated checks. +- [The pr-time-tracker](link-to-docs) verifies that the time spent on the PR has been properly logged. +- [The pr-time-tracker for bugs](link-to-docs) ensures that bug-related time tracking is correctly linked to the corresponding commit and bug author. +- [The code-rabbit](link-to-docs) validates that the code meets quality standards by checking: + - Code style and formatting + - Test coverage + - Static analysis results + - Other quality metrics🧰 Tools
🪛 LanguageTool
[style] ~92-~92: Consider using a different verb for a more formal wording.
Context: ... in "draft" status until all issues are fixed. --- ## Scoping > [!NOTE] > Here's a...(FIX_RESOLVE)
121-128: Add language specifiers to code blocks.For better syntax highlighting and markdown compliance, add language specifiers to the code blocks:
-``` +```markdown ## Feature - [/page](https://figma.com/your-design-file-url) - ./page/{params} - (group) - [[state]](https://figma.com/your-design-file-url)Apply the same change to the example code block: ```diff -``` +```markdown ## Credit Vaults - [/lending](https://figma.com/your-design-file-url) - ./vaults/{poolAddr} - (Auction) - [[Withdraw Popup]](https://figma.com/your-design-file-url) - [[Bid Popup]](https://figma.com/your-design-file-url)Also applies to: 140-147 <details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint (0.37.0)</summary> 121-121: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> --- `129-129`: **Remove trailing punctuation from heading.** Remove the colon from the heading to comply with markdown style guidelines: ```diff -#### Key: +#### Key🧰 Tools
🪛 Markdownlint (0.37.0)
129-129: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/CONTRIBUTING.md(9 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/CONTRIBUTING.md
[style] ~92-~92: Consider using a different verb for a more formal wording.
Context: ... in "draft" status until all issues are fixed. --- ## Scoping > [!NOTE] > Here's a...
(FIX_RESOLVE)
🪛 Markdownlint (0.37.0)
.github/CONTRIBUTING.md
129-129: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
121-121: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
140-140: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)
Line range hint
1-180: Overall changes look good!The changes effectively improve the documentation's clarity and structure. The new CI Checks section is a valuable addition that will help contributors understand the requirements before requesting reviews.
🧰 Tools
🪛 Markdownlint (0.37.0)
129-129: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
121-121: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
|
@zolotokrylin pls review this. |
ETA: 2 hours
resolves: https://github.com/holdex/marketing/issues/106
Summary by CodeRabbit