Improve formatting and readability of CONTRIBUTING.md#13960
Improve formatting and readability of CONTRIBUTING.md#13960soul-sapphire wants to merge 1 commit intowso2:masterfrom
Conversation
- Converted component links into bullet points - Improved inline code formatting for paths and commands - Minor readability improvements No functional changes were made.
|
|
WalkthroughMinor 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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).
| - Navigate to `wso2am-4.5.0/bin/` | ||
| - Run: | ||
| - On Linux/macOS: `./api-manager.sh -debug 5005` | ||
| - On Windows: `./api-manager.bat -debug 5005` |
There was a problem hiding this comment.
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.
| - 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).
Improved formatting in the Bug Fixing section of CONTRIBUTING.md to enhance readability.
Changes include:
No functional changes were made.
Summary by CodeRabbit