Do you guys put Naming conventions in CONTRIBUTING.md ?

bhupesh profile image ๐”น๐•™๐•ฆ๐•ก๐•–๐•ค๐•™ ๐•๐•’๐•ฃ๐•ค๐•™๐•Ÿ๐•–๐•ช ๐Ÿ‘พ ใƒป1 min read

I was reading CodeComplete the other day, learned why naming your variables, classes, packages, routines can help the make code more readable.

What I realised that this practice is not usually scene with OpenSource projects. I have seen a few big OSS where sometimes code is not readable.


If you have a medium to big scale Open-source project have you ever thought of putting a Naming Convention in the contributing guidelines.

Yes/No/thoughts ?


markdown guide