cmu-db / noisepage

Self-Driving Database Management System from Carnegie Mellon University
https://noise.page
MIT License
1.74k stars 502 forks source link

Enforce snake_case filenames. #771

Open lmwnshn opened 4 years ago

lmwnshn commented 4 years ago

We don't want camelsInFilenames.

Will probably add a rule to make check-censored later.

arshbeerSingh commented 4 years ago

Can I work on this issue?

lmwnshn commented 3 years ago

@arshbeerSingh Go for it.

arshbeerSingh commented 3 years ago

@lmwnshn thank you very much for allowing me to work on this issue. I was going through the files (in src) and noticed that all the file names are already in snake_case. Can you please clarify what exactly needs to be done (if I am mistaken)?

lmwnshn commented 3 years ago

Yes, everything is snake_case right now. But sometimes new people don't know what the convention is, and add a new file that is camelCaseOrSomething.

We would like to prevent people from doing this as part of our continuous integration pipeline. You can see an example with check-censored here, which uses grep to check the contents of files for bad words.

In this case, you want a shell script that checks all the filenames in a directory. It would probably be some combination of find and grep.