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

📝 Improve README.md #860

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

jaredsmithse
Copy link

Changes

While reading through documentation I noticed a typo, and one thing led to another 😅

  • "therefore" instead of "there for"
    • This was the first one I noticed, I think this is pretty straightforward.
  • sidekiq and "Sidekiq" instead of "sidekiq"
    • This one I am less confident of. Some were "sidekiq version" which I interpreted as maybe being "sidekiq version".
    • I capitalized everywhere else it made sense (to me)
  • Consistent string literals in code
    • I changed them from being mixed-use to double-quote. This is based off of the StandardRuby guide. If you prefer single-quote, I'm happy to change them all to consistently use that!

These were best-guess improvements, if any of the 3 are useful but not all of them, I'm also happy to remove any of them completely 🙇‍♂️

Links

### Changes
While reading through documentation I noticed a typo, and in correcting one noticed some others, so I ended up taking a stab at 3 😃 
- "therefore" instead of "there for"
  - This was the first one I noticed, I think this is pretty straightforward.
- `sidekiq` and "Sidekiq" instead of "sidekiq"
  - This one I am less confident of. Some were "sidekiq version" which I interpreted as maybe being "`sidekiq` version".
  - I capitalized everywhere else it made sense (to me)
- Consistent string literals in code
  - I changed them from being mixed-use to double-quote. This is based off of the StandardRuby guide. If you prefer single-quote, I'm happy to change them all to consistently use that! 

These were best-guess improvements, if any of the 3 are useful but not all of them, I'm also happy to remove any of them completely 🙇‍♂️ 

### Links
- [standardrb guide](https://github.com/standardrb/standard/blob/3abe01cf7ecd13ee7a4fb5b3377430311627a2fc/config/base.yml#L1742-L1745)
- [Gitmoji Ref](https://gitmoji.dev/)
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