[ALL-Chore] readme 피드백 사항 반영 #306
Conversation
WalkthroughThis pull request updates the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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: 1
🧹 Nitpick comments (2)
README.md (2)
1-2: Heading Increment Issue:
The subheading on line 2 uses###(h3) immediately after an h1 on line 1. According to markdownlint MD001, heading levels should increment by only one level (i.e. the subheading should be h2). Please update the subheading to use##instead of###.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
2-2: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3(MD001, heading-increment)
61-68: Table Surrounding Blank Lines:
The table starting on line 62 (under the "🛠️ 기술 스택" section) is not surrounded by blank lines, which violates markdownlint MD058. Consider inserting a blank line after the heading (above the table) and after the table before the next section. This will improve readability and ensure consistent markdown formatting.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
62-62: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
2-2: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
62-62: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
146-146: No empty links
null
(MD042, no-empty-links)
README.md
Outdated
| - [🔥 백엔드의 비밀이 궁금하다면?](https://github.com/softeer5th/Team4-enDolphin/wiki/Backend) | ||
| - [🌈 프론트엔드의 고민을 알고싶다면?](https://github.com/softeer5th/Team4-enDolphin/wiki/Frontend) | ||
| - [☄️ 회의록](https://bside.notion.site/efba066ebf0d47b98017b5924ce9e30d) | ||
| - [⚡ ️Swagger API]() |
There was a problem hiding this comment.
Empty Link in Team Documentation:
The link for "⚡ ️Swagger API" on line 146 is empty. Please either provide a valid URL or remove this entry from the team documentation section to avoid broken or misleading links.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
146-146: No empty links
null
(MD042, no-empty-links)
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.md (1)
139-146:⚠️ Potential issueTeam Documentation: Remove Empty List Item
A new "팀 문서" section has been added (lines 139–145). However, line 146 shows an empty list item which could lead to a broken or confusing bullet point in the rendered output. Please remove this empty entry to ensure clean and accurate documentation.
🧹 Nitpick comments (2)
README.md (2)
59-60: Horizontal Rule Formatting
A horizontal rule has been inserted on lines 59–60 to separate sections. For improved readability and to better comply with markdown conventions, consider ensuring that the horizontal rule is surrounded by blank lines.
61-68: Table Surrounding Space for Technology Stack Section
The "기술 스택" section immediately follows the horizontal rule without a blank line before the table that starts on line 62. Many markdown lint rules (e.g., MD058) recommend that tables be surrounded by blank lines. Adding a blank line before (or after) the table header could improve readability and prevent potential rendering issues.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
62-62: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
2-2: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
62-62: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
| # ⏰ 언제 만나? | ||
| ### 바쁜 학생들을 위한 가장 완벽한 약속 시간 찾기 |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Heading Hierarchy Adjustment
The main title is defined as an H1 on line 1 but its subtitle on line 2 is set as an H3. To maintain a proper heading hierarchy (and to satisfy markdownlint MD001), consider changing the subtitle to H2 unless there’s an intentional design decision.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
2-2: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
|
고생하셨습니다 |
#️⃣ 연관된 이슈>
📝 작업 내용> 이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)
🙏 여기는 꼭 봐주세요! > 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요
Summary by CodeRabbit