Closed MaximilienNaveau closed 4 years ago
The file extensions used are not wrong, per se. Many header extensions are acceptable for C++, including ".h", ".hh", ".hpp", ".hxx", and ".h++". Which to use is up to a project maintainer's personal preference, and I can see no indication of it being ".hpp" for this particular project. ".hh" is obviously C++ to anyone looking, so I don't understand why you want to change it.
A notable problem presented by a change like the one you're proposing is an API incompatibility. People currently using the library who update it will be treated with missing #include
's everywhere they use the library since the header names have changed. This is not inherently bad, but must be reserved for a major version change as opposed to a minor one. Breaking changes need to be treated with care.
Since you're a collaborator, you probably know the will of the maintainer better than I do. I would be happy to add a pull request if they approve. Even so, I wouldn't try to alter the convention currently used by the project for reasons mentioned above. No user will be surprised (or care) if the file extension is ".hh", but they will if a breaking API change (like the one you're proposing) is slipped into a minor update. Just something to note.
i agree that this is an important point and changing extensions should not be done lightly. therefore i urge @MaximilienNaveau to reconsider his plans. I suggest we set a video call to discuss this issue.
@gazarahmad I don't think a video call is necessary for something this trivial, nor convenient for external contributors. This discussion section serves its purpose plenty well.
agreed, we can pursue this discussion here for now, but in the future we may want to have video meetings on a regular basis. nevertheless, i would like to reiterate my concern over the possible ramifications of such a change. in addition i would like to advise @MaximilienNaveau to exercise more restraint in the future and to report any progress on this issue directly to us.
agreed on the video meeting. This would give us a chance to explain to @MaximilienNaveau the naming conventions regarding header files.
perfect, so we should schedule a meeting ASAP. i would suggest that we also include @sheim as his expertise may be valuable in this matter. i would suggest the following meeting agenda, please feel free to amend it as you see fit:
please let me know in case you disagree with any of the above.
I apologize @gazarahmad - I wasn't originally under the impression that you were part of the development team (or equivalent). Your GitHub profile indicates you joined GitHub today.
No problem, thanks for pointing out the issue!
Problem
The file name convention is wrong for the headers.
Potential solution
use the .hpp extension instead of the hh