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

Capitalise Makefile filename #798

Closed
wants to merge 1 commit into from
Closed

Conversation

andygout
Copy link
Contributor

I kept not being able to find the Makefile because I was looking for its name being capitalised.

This creates consistency with how it is written elsewhere throughout Customer Products.

@andygout andygout requested a review from magsallen April 16, 2020 11:01
@andygout andygout requested a review from a team as a code owner April 16, 2020 11:01
@magsallen
Copy link
Contributor

Oh I'm not sure about this 😕 What apps are you trying to be consistent with?

@magsallen magsallen added the Housekeeping Mainly repo maintenance label Apr 16, 2020
@andygout
Copy link
Contributor Author

At least the 17 apps on which we are currently performing Page Kit migrations: #794.

@magsallen
Copy link
Contributor

On the one hand, you've made a strong case for consistency! On the other, we don't use this capitalisation pattern for any other root-level files and I don't mind Page Kit breaking with conventions when we have a good reason to. On balance, I can reluctantly accept this based on the fact that it might improve usability, but I'd be interested to know why we capitalise the Makefile in our existing repos - this doesn't seem to be backed by any other conventions.

@andygout
Copy link
Contributor Author

Seems the convention is to capitalise (although the reasoning for this comes from the handling of letter casing only on certain operating systems): https://stackoverflow.com/questions/14368941/is-the-convention-for-naming-make-files-to-use-a-capital-m-such-as-makefile/14368985

Having only ever seen it capitalised means my muscle memory kept missing it in lowercase, so this PR was made exclusively from a usability angle.

Happy to merge or close either way.

@andygout
Copy link
Contributor Author

Agreed offline to close.

@andygout andygout closed this Apr 22, 2020
@andygout andygout deleted the capitalise-makefile-filename branch April 22, 2020 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Housekeeping Mainly repo maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants