Update README for clarity and consistency #1034
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fallwith
requested changes
Mar 23, 2022
| @@ -8,7 +8,7 @@ You can also extend the agent's performance monitoring to | |||
| [collect and analyze business data](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/introduction-new-relic-ruby#business-data) | |||
| to help you improve the customer experience and make data-driven business decisions. | |||
|
|
|||
| The New Relic Ruby Agent is dual-purposed as a either a Gem or a Rails plugin, | |||
| The New Relic Ruby agent is dual-purposed as either a Gem or a Rails plugin, | |||
There was a problem hiding this comment.
A -> a seems to put us in alignment with the majority of the other agents. Looks like Python's still rocking an A. The change makes sense. 👍
tannalynn
previously approved these changes
Mar 23, 2022
kaylareopelle
previously approved these changes
Mar 24, 2022
hannahramadan
dismissed stale reviews from kaylareopelle, fallwith, and tannalynn
via
67ba32c
fallwith
previously approved these changes
Mar 24, 2022
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before contributing, please read our contributing guidelines and code of conduct.
Overview
Updated capitalization of "New Relic Ruby agent" to be consistent with marketing materials. Added punctuation and defined "CLA" for clarity. Updated README sign-off.
Related Github Issue
Include a link to the related GitHub issue, if applicable
Testing
The agent includes a suite of unit and functional tests which should be used to
verify your changes don't break existing functionality. These tests will run with
Github Actions when a pull request is made. More details on running the tests locally can be found
here for our unit tests,
and here for our functional tests.
For most contributions it is strongly recommended to add additional tests which
exercise your changes.
Reviewer Checklist