Skip to content

Conversation

@bug-ops
Copy link
Owner

@bug-ops bug-ops commented Dec 16, 2025

Summary

  • Improve main README with GitHub callouts, better structure, MSRV documentation, and feature flag tables
  • Add CONTRIBUTING.md with comprehensive development workflow, commit conventions, and contribution guidelines
  • Update CHANGELOG.md with recent Phase 5.1 features (HTTP bindings, podcast support, cargo-make migration)
  • Update feedparser-rs-core README with HTTP fetching examples and new features
  • Fix markdown lint warnings (duplicate headings)

Changes

README.md

  • Add GitHub callouts (> [!IMPORTANT], > [!TIP], > [!NOTE]) for better UX
  • Add cargo features table documenting the http feature
  • Add workspace structure table with links to all crates
  • Document MSRV policy (1.88.0, edition 2024)
  • Improve code examples with error handling and URL fetching

CONTRIBUTING.md (new)

  • Development prerequisites and setup instructions
  • Branch naming conventions
  • Commit message format (Conventional Commits)
  • Code style guidelines for Rust
  • PR process and checklist
  • Testing instructions
  • Architecture overview

CHANGELOG.md

  • Document Phase 5.1 features: HTTP bindings, podcast support
  • Document cargo-make migration
  • Clean up format

crates/feedparser-rs-core/README.md

  • Add HTTP fetching section with code examples
  • Add podcast support to features list
  • Document how to disable HTTP feature

Test plan

  • Verify README renders correctly on GitHub
  • Verify all links work
  • Verify callouts render properly
  • Review CONTRIBUTING.md for completeness

- Improve README with GitHub callouts, better structure, and feature tables
- Add CONTRIBUTING.md with development workflow and guidelines
- Update CHANGELOG with recent features (HTTP bindings, podcast support)
- Update feedparser-rs-core README with HTTP fetching examples
- Fix markdown lint warnings (duplicate headings)
@codecov-commenter
Copy link

codecov-commenter commented Dec 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #15   +/-   ##
=======================================
  Coverage   78.80%   78.80%           
=======================================
  Files          27       27           
  Lines        4303     4303           
=======================================
  Hits         3391     3391           
  Misses        912      912           
Flag Coverage Δ
rust-core 78.80% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

- Add bug report issue template (YAML form)
- Add feature request issue template (YAML form)
- Add issue template config with discussion link
- Add pull request template with checklist
@bug-ops bug-ops merged commit 34a5681 into main Dec 16, 2025
28 checks passed
@bug-ops bug-ops deleted the docs/prepare-for-publication branch December 16, 2025 01:56
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.

3 participants