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

Allow db to allowed names of Naming/UncommunicativeMethodParamName cop in default config #6137

Merged

Conversation

michaelabon
Copy link

@michaelabon michaelabon commented Jul 27, 2018

Add db to AllowedNames in default configuration for cop
Naming/UncommunicativeMethodParamName in order to allow talking about or
configuring a particular database.

I think that using the shorter db is unambiguous while still being descriptive, rather than writing out database.


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 rake default or rake parallel. It executes all tests and RuboCop for itself, and generates the documentation.

@michaelabon michaelabon changed the title Allow db as method paramter in default config Allow db to allowed names of Naming/UncommunicativeMethodParamName cop in default config Jul 27, 2018
@michaelabon michaelabon force-pushed the allow-db-in-naming-uncommunicative branch 2 times, most recently from 27e6667 to b08cfa8 Compare July 27, 2018 17:49
CHANGELOG.md Outdated
@@ -2,6 +2,8 @@

## master (unreleased)

* [#6137](https://github.com/rubocop-hq/rubocop/pull/6137): Allow `db` to allowed names of `Naming/UncommunicativeMethodParamName` cop in default config. ([@mkenyon][])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you please add the ### Changes section?

 ## master (unreleased)

+ ### Changes
+
  * [#6137](https://github.com/rubocop-hq/rubocop/pull/6137): Allow `db` to allowed names of `Naming/UncommunicativeMethodParamName` cop in default config. ([@mkenyon][])

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@koic Oh, of course!

@michaelabon michaelabon force-pushed the allow-db-in-naming-uncommunicative branch from b08cfa8 to 682cc3e Compare July 31, 2018 01:01
CHANGELOG.md Outdated
@@ -3491,3 +3495,5 @@
[@kenman345]: https://github.com/kenman345
[@nijikon]: https://github.com/nijikon
[@mikeyhew]: https://github.com/mikeyhew
[@kenman345]: https://github.com/kenman345
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI has failed. Would you please delete this line?
https://travis-ci.org/rubocop-hq/rubocop/jobs/410116964#L1119

 [@mikeyhew]: https://github.com/mikeyhew
-[@kenman345]: https://github.com/kenman345
 [@mkenyon]: https://github.com/mkenyon

Add `db` to AllowedNames in default configuration for cop
Naming/UncommunicativeMethodParamName in order to allow talking about or
configuring a particular database.
@michaelabon michaelabon force-pushed the allow-db-in-naming-uncommunicative branch from 682cc3e to 03f66a6 Compare July 31, 2018 20:01
@koic koic merged commit c853715 into rubocop:master Aug 1, 2018
@koic
Copy link
Member

koic commented Aug 1, 2018

This looks like adding a reasonable name 🌟 Thanks for your first time contribution!

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