Skip to content
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

Edit suggestions for ARCHITECTURE and CONTRIBUTING #610

Merged
merged 1 commit into from
Jun 11, 2021

Conversation

StephenBarlow
Copy link
Contributor

No description provided.

@StephenBarlow
Copy link
Contributor Author

@EverlastingBugstopper These additions look great! My PR is mostly cosmetic stuff. Here are some style-guide-like rules I follow that informed some of these edits (just in case this is interesting):

  • "In order to" can always be shortened to "To"
  • Use "because" instead of "since" or "as", because those words have other meanings and reducing word ambiguity is great for non-native English readers
  • Similarly, use "might" instead of "may" for something that might happen. Use "can" instead of "may" for something that is permitted. This prevents using "may" in either situation, further reducing ambiguity
  • Use numbered lists only for describing a chronological sequence of steps (otherwise, use bullets)
  • Phrases like "you'll want to" can usually be shortened to an imperative using the verb that immediately follows ("You'll want to open the..." -> "Open the")

All of these are super minor but hopefully combine to improve succinctness and clarity 🤷‍♂️

@EverlastingBugstopper EverlastingBugstopper merged commit c82bc83 into avery/xtask Jun 11, 2021
@EverlastingBugstopper EverlastingBugstopper deleted the sb/contributing-edits branch June 11, 2021 13:49
@EverlastingBugstopper
Copy link
Contributor

Thanks Stephen! These tips are super helpful

@EverlastingBugstopper EverlastingBugstopper added this to the June 22 milestone Jun 22, 2021
EverlastingBugstopper added a commit that referenced this pull request Aug 23, 2021
* docs: document --output json

* chore: apply style guide rules from #610

* Edits to JSON output docs (#754)

Co-authored-by: Stephen Barlow <stephen@apollographql.com>
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.

2 participants