Skip to content

Streamline README for clarity and brevity#6

Merged
colesmcintosh merged 1 commit intomainfrom
streamline-readme
Dec 27, 2025
Merged

Streamline README for clarity and brevity#6
colesmcintosh merged 1 commit intomainfrom
streamline-readme

Conversation

@colesmcintosh
Copy link
Owner

Summary

  • Reduce README from 245 to 94 lines (62% smaller)
  • Replace verbose operation examples with a table and compact code block
  • Consolidate Development/CI/CD/Contributing into one concise section

Reduce README from 245 to 94 lines by:
- Removing redundant Overview and Key Features sections
- Replacing verbose operation examples with a table and compact code block
- Consolidating Development/CI/CD/Contributing sections
- Using tables for configuration and operations reference
@github-actions
Copy link

👋 Welcome to langchain-salesforce!

Thank you for contributing! Your pull request will be automatically checked for:

  • Code formatting (ruff format)
  • Import sorting (ruff)
  • Linting (ruff check)
  • Type checking (mypy)
  • Spelling (codespell)
  • Unit tests (pytest)

🔍 Required Checks

All pull requests must pass the following checks before merging:

  • Pull Request Checks workflow must complete successfully
  • All required status checks must be green

🧪 Integration Tests

Integration tests will run automatically on pushes to main. For pull requests, add the integration-tests label to trigger them.

🚀 Getting Started

If you need to fix any issues:

  1. Format code: make format
  2. Check linting: make lint
  3. Run tests: make test

The CI checks will update automatically when you push new commits.

📚 Documentation


This comment was automatically generated by GitHub Actions.

@colesmcintosh colesmcintosh merged commit b9e6e46 into main Dec 27, 2025
8 checks passed
@colesmcintosh colesmcintosh deleted the streamline-readme branch December 27, 2025 22:44
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.

1 participant