Skip to content

Conversation

@jonpspri
Copy link
Contributor

📌 Summary

This PR cleans up the CONTRIBUTING.md file by removing all FIXME annotations and providing proper references to existing documentation. It also fixes a bash syntax error in the Makefile's lint-smart target.

🔧 Changes

CONTRIBUTING.md

  • Removed all FIXME annotations from links and sections
  • Kept links pointing to upstream IBM repository as requested
  • Updated Communication section to reference issue tracker
  • Updated Setup section with references to README Quick Start and Installation sections
  • Updated Testing section with reference to Bug-fix PR template and key test commands
  • Updated Coding style guidelines with basic standards and reference to CLAUDE.md
  • Fixed all markdown linting errors:
    • Added top-level # CONTRIBUTING header
    • Added language specifiers to code blocks (c, text, bash)
    • Added proper blank lines around all headings
    • Added blank lines around lists

Makefile

  • Fixed bash syntax error on line 833 in lint-smart target (removed extra fi statement)

🧪 Verification

Check Command Status
Markdown linting make lint CONTRIBUTING.md ✅ Pass
Makefile syntax make lint-smart ✅ Pass

✅ Checklist

  • All FIXME annotations removed
  • Links verified and pointing to upstream repository
  • Markdown linting passes with 0 errors
  • Bash syntax error fixed
  • Code formatted and committed with sign-off

🤖 Generated with Claude Code

- Remove all FIXME annotations from CONTRIBUTING.md
- Update Communication, Setup, Testing, and Coding style guidelines sections
- Add references to existing documentation (README, CLAUDE.md, PR templates)
- Fix Makefile:833 bash syntax error (extra fi statement in lint-smart target)
- Fix all markdown linting errors in CONTRIBUTING.md:
  - Add top-level # CONTRIBUTING header
  - Add language specifiers to code blocks
  - Add proper blank lines around headings and lists

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Signed-off-by: Jonathan Springer <[email protected]>
Copilot AI review requested due to automatic review settings October 13, 2025 08:30
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR performs cleanup tasks on the CONTRIBUTING.md file and fixes a bash syntax error in the Makefile. The main purpose is to remove all FIXME annotations from the contributing guidelines and provide proper documentation references, while also addressing a syntax issue that was preventing the lint-smart target from executing correctly.

  • Removed all FIXME annotations and replaced them with proper links and documentation references
  • Fixed a bash syntax error in the Makefile's lint-smart target by removing an orphaned fi statement
  • Added proper markdown formatting including headers, code block language specifiers, and spacing

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
Makefile Removed orphaned fi statement that was causing bash syntax error in lint-smart target
CONTRIBUTING.md Comprehensive cleanup removing FIXME annotations, adding proper documentation references, and fixing markdown formatting

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link
Member

@crivetimihai crivetimihai left a comment

Choose a reason for hiding this comment

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

Good catch, thanks!

@crivetimihai crivetimihai merged commit 2d6d17e into IBM:main Oct 13, 2025
35 checks passed
@jonpspri jonpspri deleted the chore/clean-up-contributing branch October 13, 2025 09:57
p4yl04d3r pushed a commit to p4yl04d3r/mcp-context-forge that referenced this pull request Nov 19, 2025
…ror (IBM#1233)

- Remove all FIXME annotations from CONTRIBUTING.md
- Update Communication, Setup, Testing, and Coding style guidelines sections
- Add references to existing documentation (README, CLAUDE.md, PR templates)
- Fix Makefile:833 bash syntax error (extra fi statement in lint-smart target)
- Fix all markdown linting errors in CONTRIBUTING.md:
  - Add top-level # CONTRIBUTING header
  - Add language specifiers to code blocks
  - Add proper blank lines around headings and lists

Signed-off-by: Jonathan Springer <[email protected]>
Signed-off-by: p4yl04d3r <[email protected]>
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