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

Add Readme Badge section to README.md #8184

Merged
merged 3 commits into from Jun 21, 2020
Merged

Conversation

@vaporyhumo
Copy link
Contributor

vaporyhumo commented Jun 21, 2020

This PR adresses issue #8182

Added a Readme Badge section to the readme, with an example badge other people can use in their projects to show adherence to The Ruby Style Guide.

I've thrown it between the Compatibility and Team sections; I'm willing to modify the order on request.

The section and badge have been taken and modified from the Standard proyect.

Before submitting the PR make sure the following are checked:

  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.
vaporyhumo added 2 commits Jun 21, 2020
Add Readme Badge section to the readme
Add the badge on top too.
@vaporyhumo
Copy link
Contributor Author

vaporyhumo commented Jun 21, 2020

Just tell me if any changes are needed @bbatsov. I can reword/squash commits when it's ready.

README.md Show resolved Hide resolved
@vaporyhumo vaporyhumo requested a review from bbatsov Jun 21, 2020
Copy link
Collaborator

bbatsov left a comment

Looks good! Thanks!

@bbatsov bbatsov merged commit 8c5cbc7 into rubocop-hq:master Jun 21, 2020
25 of 26 checks passed
25 of 26 checks passed
windows 2.4
Details
windows 2.5
Details
windows 2.6
Details
windows 2.7
Details
windows mingw
Details
ci/circleci: cc-upload-coverage Your tests are queued behind your running builds
Details
ci/circleci: cc-setup Your tests passed on CircleCI!
Details
ci/circleci: documentation-checks Your tests passed on CircleCI!
Details
ci/circleci: jruby-9.2-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: jruby-9.2-rubocop Your tests passed on CircleCI!
Details
ci/circleci: jruby-9.2-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.4-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.4-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.4-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.5-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.5-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.5-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.6-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.6-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.6-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.7-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.7-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.7-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-head-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-head-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-head-spec Your tests passed on CircleCI!
Details
@vaporyhumo
Copy link
Contributor Author

vaporyhumo commented Jun 21, 2020

Glad to help, thanks to you too.

@vaporyhumo vaporyhumo deleted the vaporyhumo:patch-1 branch Jun 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.