Skip to content

Improve formatting and readability of CONTRIBUTING.md#13960

Open
soul-sapphire wants to merge 1 commit intowso2:masterfrom
soul-sapphire:fix-doc-formatting
Open

Improve formatting and readability of CONTRIBUTING.md#13960
soul-sapphire wants to merge 1 commit intowso2:masterfrom
soul-sapphire:fix-doc-formatting

Conversation

@soul-sapphire
Copy link
Copy Markdown

@soul-sapphire soul-sapphire commented Feb 17, 2026

Improved formatting in the Bug Fixing section of CONTRIBUTING.md to enhance readability.

Changes include:

  • Converted component links into bullet points
  • Improved inline code formatting for paths and commands
  • Minor readability adjustments

No functional changes were made.

Summary by CodeRabbit

  • Documentation
    • Updated contributing guidelines with improved formatting and clarity.
    • Added platform-specific instructions for Linux/macOS and Windows in the debug setup process.
    • Enhanced navigation path documentation with better formatting conventions.

- Converted component links into bullet points
- Improved inline code formatting for paths and commands
- Minor readability improvements

No functional changes were made.
@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 17, 2026

Walkthrough

Minor documentation improvements to CONTRIBUTING.md including formatting refinements in the Bug Fixing section, wrapping navigation paths in backticks, and expanding the Debug the Product step with platform-specific commands for Linux/macOS and Windows.

Changes

Cohort / File(s) Summary
Documentation Formatting
CONTRIBUTING.md
Enhanced formatting and clarity with consistently capitalized URLs in Bug Fixing section, backtick-wrapped navigation paths, and expanded platform-specific debug instructions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A document polished, so shiny and bright,
With platform-specific paths, now perfectly right,
Backticks and formatting, clarity's friend,
Contributing becomes easier—hop to the end! 📝✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: formatting and readability improvements to CONTRIBUTING.md, which aligns with the summary of changes and PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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.

❤️ Share

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 55-58: Update the Windows debug command entry that currently shows
"./api-manager.bat -debug 5005" so it uses the correct Windows invocation;
replace it with either ".\api-manager.bat -debug 5005" for PowerShell usage or
simply "api-manager.bat -debug 5005" for cmd.exe (locate the Windows command
string "./api-manager.bat -debug 5005" in CONTRIBUTING.md and update
accordingly).

Comment thread CONTRIBUTING.md
Comment on lines +55 to +58
- Navigate to `wso2am-4.5.0/bin/`
- Run:
- On Linux/macOS: `./api-manager.sh -debug 5005`
- On Windows: `./api-manager.bat -debug 5005`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Windows path separator should use backslash or be omitted.

The debug instructions now clearly separate platform-specific commands, which is great. However, the Windows command uses ./ (Unix-style forward slash), which may not work reliably in Windows cmd.exe.

On Windows:

  • PowerShell: Use .\ (backslash) for current directory
  • cmd.exe: The prefix is typically omitted
📝 Suggested fix for Windows command
-   - On Windows: `./api-manager.bat -debug 5005` 
+   - On Windows: `.\api-manager.bat -debug 5005`

Or alternatively, omit the prefix entirely:

-   - On Windows: `./api-manager.bat -debug 5005` 
+   - On Windows: `api-manager.bat -debug 5005`
📝 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
- Navigate to `wso2am-4.5.0/bin/`
- Run:
- On Linux/macOS: `./api-manager.sh -debug 5005`
- On Windows: `./api-manager.bat -debug 5005`
- Navigate to `wso2am-4.5.0/bin/`
- Run:
- On Linux/macOS: `./api-manager.sh -debug 5005`
- On Windows: `.\api-manager.bat -debug 5005`
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` around lines 55 - 58, Update the Windows debug command entry
that currently shows "./api-manager.bat -debug 5005" so it uses the correct
Windows invocation; replace it with either ".\api-manager.bat -debug 5005" for
PowerShell usage or simply "api-manager.bat -debug 5005" for cmd.exe (locate the
Windows command string "./api-manager.bat -debug 5005" in CONTRIBUTING.md and
update accordingly).

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.

2 participants