-
Notifications
You must be signed in to change notification settings - Fork 22
docs: use active voice in README - replace "have" with "provide" #1046
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
121a7c5
to
2966a46
Compare
That's an interesting empty commit 🤔 This PR is a demo of https://github.blog/changelog/2025-07-14-start-and-track-github-copilot-coding-agent-sessions-from-visual-studio-code/ |
Before:
Their After:
The before and after aren't all that different 🤔 If updating to be active voice, I'd hope for something more like:
|
Co-authored-by: vmccarty <[email protected]>
... Good point! I've implemented your suggested rewrite to make it truly active voice. The sentence now starts with "Use" and is much more direct and engaging. Changes made in commit 511cd1f. |
@vmccarty I suppose so! But that really doesn't gel with the rest of the paragraph 😅 |
@ericcrosson-bitgo, oh, well it can be tweaked to better fit then. At any rate, the After that copilot proposed was still passive voice. Just calling that out. |
This PR improves the README by replacing passive voice with active voice on lines 16-17.
Changes:
Before:
After:
This makes the sentence more direct and active, improving readability and clarity of the documentation. The change transforms the passive construction into a more engaging active voice that better describes what the API definitions actually do.
✅ Build and tests continue to pass
✅ No functional changes to code
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.