Skip to content

Enhance README with comprehensive installation instructions, examples, and usage guide - #3

Merged
HeyItsGilbert merged 2 commits into
mainfrom
copilot/fix-2
Aug 18, 2025
Merged

HeyItsGilbert merged 2 commits into
mainfrom
copilot/fix-2

Conversation

Copilot AI commented Aug 18, 2025

Copy link
Copy Markdown
Contributor

The original README was very sparse with only basic installation steps and minimal context. This enhancement transforms it into a comprehensive guide that addresses all the requested improvements.

Key Improvements

What is Agentic Language Section
Added a clear explanation of the concept with practical before/after examples:

  • ❌ "I helped improve the system" → ✅ "I improved the system"
  • ❌ "I'm a team player" → ✅ "I collaborate effectively"

Multiple Installation Methods
Expanded from a single method to three comprehensive approaches:

  1. Download from releases (recommended)
  2. Clone repository
  3. Git submodule integration

Practical Examples with Real Output
Included actual Vale output showing how the tool works:

example.md:1:3:agentic.communal:Consider replacing 'improved'. It is communal vs agentic.
example.md:1:50:agentic.communal:Consider replacing 'team player'. It is communal vs agentic.  

Enhanced Configuration
Provided detailed .vale.ini examples with customization options for different file types and alert levels.

Usage Examples
Added command-line usage examples, editor integrations (VS Code, Vim, Emacs), and filtering options.

Reference Documentation

  • Rules reference explaining agentic.communal and agentic.communal_alternative
  • Common issues table with suggested alternatives
  • Troubleshooting section for common setup problems

Vale Compatibility Fix
Removed deprecated code: false parameter from communal.yml that was causing failures with newer Vale versions.

The README grew from 25 lines to 170 lines of comprehensive documentation, providing users with everything needed to understand, install, and effectively use the vale-agentic style package.

Fixes #2.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • install.goreleaser.com
    • Triggering command: curl -sfL REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI commented Aug 18, 2025

Copy link
Copy Markdown
Contributor Author

@HeyItsGilbert 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

Copilot AI changed the title [WIP] Update Readme to include example Enhance README with comprehensive installation instructions, examples, and usage guide Aug 18, 2025
Copilot AI requested a review from HeyItsGilbert August 18, 2025 15:21
@HeyItsGilbert
HeyItsGilbert marked this pull request as ready for review August 18, 2025 15:26
…, and usage guide

Co-authored-by: HeyItsGilbert <615265+HeyItsGilbert@users.noreply.github.com>
Comment thread README.md Outdated
@HeyItsGilbert
HeyItsGilbert merged commit fdd2fa0 into main Aug 18, 2025
2 checks passed
@HeyItsGilbert
HeyItsGilbert deleted the copilot/fix-2 branch August 18, 2025 15:29
@devactivity-app

Copy link
Copy Markdown

Pull Request Summary by devActivity

Metrics

Cycle Time: 16m Coding Time: < 1 min Pickup Time: 5m Review Time: 1m Comments: 1

Achievements

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.

Update Readme to include example

2 participants