Fix Linter issues in Markdown files

[VimukthiPerera]

Purpose

Fix Linter issues in md files

Security checks

• Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes
• Ran FindSecurityBugs plugin and verified report? N/A
• Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes

Summary by CodeRabbit

• Documentation

  • Clarified and reflowed guidance across contributing, PR, code-of-conduct, and templates; added a "Community-Driven" highlight and standardized issue/pull-request guidance for consistency
  • Expanded linting and contribution guidance and adjusted template prompts and sections for clearer contributor workflow

• Style

  • Consistent whitespace, punctuation, heading and list formatting applied across docs for improved readability and alignment

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2d62ea6e-612b-4d21-872b-2ab75ea71f3a

📥 Commits

Reviewing files that changed from the base of the PR and between 301b519 and f308f51.

📒 Files selected for processing (6)

• .github/linters/README.md
• CODE_OF_CONDUCT.md
• README.md
• docs/CONTRIBUTING.md
• issue_template.md
• pull_request_template.md

✅ Files skipped from review due to trivial changes (2)

• pull_request_template.md
• issue_template.md

---

Walkthrough

Repository-wide editorial updates to documentation and templates: whitespace, line breaks, punctuation, and list/table formatting. CONTRIBUTING and pull request template gained expanded/restructured guidance; README added a "Community-Driven" bullet. No code, behavior, or public API changes.

Changes

Cohort / File(s)	Summary
Linting docs .github/linters/README.md	Whitespace, blank-line, and table alignment adjustments; removed/added blank lines and refined subsection spacing.
Repository metadata CODE_OF_CONDUCT.md, README.md	Typographic and punctuation normalization (e‑mail → email), URL/angle-bracket formatting, line-wrapping; README adds a "Community-Driven" bullet.
Contributing guide docs/CONTRIBUTING.md	Reformatted contribution steps to a compact list, adjusted indentation/spacing, reworded small phrasing (e.g., "repo" → "repository"), and added explicit linter guidance.
Issue & PR templates issue_template.md, pull_request_template.md	Adjusted blank-line spacing and end-of-file newline; PR template reorganized and expanded with standardized guidance blocks (Purpose, Goals, Approach, Tests, Security, etc.).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Suggested reviewers

• HiranAdikari

Poem

🐰 I nibble lines and smooth their rhyme,

I hop through headings, fix the time,
Templates tidy, README beams,
Small hops of care, big tidy dreams.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The pull request description is incomplete. It only provides the Purpose and Security checks sections, missing critical sections like Goals, Approach, Documentation, and other required template fields.	Expand the description to include Goals (what the fixes accomplish), Approach (specifics of the linter fixes applied), and at minimum indicate N/A for non-applicable sections like Training, Marketing, and Migrations.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title accurately describes the main objective of the changeset - fixing linter issues across multiple Markdown files in the repository.
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

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@issue_template.md`:
- Around line 7-11: Replace the mojibake occurrences of "can�t" in the
template text with the correct character sequence "can't" (update both instances
shown as the comment text and the Suggested Assignees comment), and ensure the
file is saved/committed using UTF-8 encoding so the apostrophe renders correctly
in GitHub and when copying the issue content.

In `@pull_request_template.md`:
- Line 15: Remove the stray trailing ">" after the "Summary of user stories
addressed by this change" line and replace the mojibake sequences (�, �,
thereâ��s) with proper Unicode punctuation—use opening and closing smart quotes
(“ ”) and an apostrophe in "there's"—in the pull_request_template.md occurrences
around the same summary line and the text blocks that currently contain the
corrupted quotes (the strings on the lines flagged as 23 and 31).

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4b7c788d-ef7f-44aa-8ef7-2bd9ad6e5aa3

📥 Commits

Reviewing files that changed from the base of the PR and between 747857d and e394937.

📒 Files selected for processing (6)

• .github/linters/README.md
• CODE_OF_CONDUCT.md
• README.md
• docs/CONTRIBUTING.md
• issue_template.md
• pull_request_template.md

[Copilot]

Pull request overview

This PR focuses on cleaning up Markdown formatting to satisfy linting rules across repository templates and documentation.

Changes:

• Normalized spacing/blank lines and list formatting in templates and docs
• Standardized bullet styles and reduced trailing whitespace
• Improved Markdown readability in linter documentation

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
pull_request_template.md	Adjusts spacing/blank lines and list formatting for markdownlint compliance
issue_template.md	Fixes whitespace and adds spacing between sections for linting/readability
docs/CONTRIBUTING.md	Reformats lists for consistent Markdown style and readability
README.md	Minor Markdown formatting updates (blank lines / list style)
CODE_OF_CONDUCT.md	Converts * lists to - lists and fixes spacing issues
.github/linters/README.md	Cleans up examples, spacing, and Markdown table formatting

Comments suppressed due to low confidence (3)

pull_request_template.md:1

• These strings contain mojibake (mis-decoded smart quotes/apostrophes like � / �), which will render incorrectly and may keep triggering Markdown/text lint rules. Replace them with proper UTF-8 punctuation (e.g., “/”/’) or plain ASCII quotes (\" / ') consistently.

## Purpose

issue_template.md:7

• This comment contains a mis-decoded apostrophe (can�t). Replace with a proper apostrophe (can't) or consistent UTF-8 punctuation to avoid broken rendering.

<!-- Optional comma separated list of suggested labels. Non committers can�t assign labels to issues, so this will help issue creators who are not a committer to suggest possible labels-->

pull_request_template.md:46

• This template links to the secure engineering guidelines over HTTP. If an HTTPS version is available, prefer https://... to avoid downgrade/MITM risks when contributors click through.

- Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes/no

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.