Make sure that file name and defined class on the file matches. #3154
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
GustavoCaso
force-pushed
the
force-file-name-match-class-name
branch
2 times, most recently
from
2e8c023 to
c0313ec
Compare
By following the Ruby convention that most Ruby developers are used to, makes it easy to find the files and classes on our codebase. I excluded certain files to avoid having to do a big rename. For example to have a class name be OpenTelemtry we would need the filename or directory be open_telemetry. Those changes makes looking at the git history hard, and the might not provide a lot of value. Also, there are certain names in the industry that will not match the ruby conventition such as MongoDB.
GustavoCaso
force-pushed
the
force-file-name-match-class-name
branch
from
c0313ec to
dcef8da
Compare
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.
By following the Ruby convention that most Ruby developers are used to makes it easy to find the files and classes on our codebase.
The Ruby Convention states:
hello.rb-> class or moduleHellohelloworld.rb-> class or moduleHelloworldhello_world.rb-> class or moduleHelloWorldhello/world.rb-> class or moduleHello::WorldI excluded specific files to avoid having to do a big rename. For example, to have a class name be OpenTelemtry, we would need the filename or directory to be open_telemetry.
Those changes make looking at the git history hard and might not provide much value.
Also, specific names in the industry will not match the ruby convention, such as MongoDB.
I added all the reasonable configurations to this cop and added the list of files that need to change in
.rubocop_todo.yml.That way, this PR only makes sure that no new files that not follow the ruby convention can be added to the repository, as well as having a list of files to slowly change 😄
What does this PR do?
Motivation:
Additional Notes:
How to test the change?
For Datadog employees:
credentials of any kind, I've requested a review from
@DataDog/security-design-and-guidance.Unsure? Have a question? Request a review!