File names should clearly communicate their purpose and functionality. Avoid generic, ambiguous, or numbered names (like "Makefile2") that don't convey the file's actual role or lead to recurring questions.
File names should clearly communicate their purpose and functionality. Avoid generic, ambiguous, or numbered names (like “Makefile2”) that don’t convey the file’s actual role or lead to recurring questions.
Choose names that:
For example, instead of:
Makefile2 # What does the "2" mean? What is this for?
Use:
vendor.make # Clearly indicates this handles vendoring operations
This practice enhances code maintainability and reduces onboarding time for new developers, who can understand a file’s purpose at a glance rather than having to investigate its contents or ask questions.
Enter the URL of a public GitHub repository