pitchfork
pitchfork copied to clipboard
feedback
Hello,
So I just tested pitchfork for the first time. Here is the remarks I have after running pf new
Tests:
- I would have loved that a menu proposed me to directly use a testing framework (e.g. Catch2, or gtest), and creates a test using this framework.
Build
- I try to build the project immediately, and cmake complained because the folder
third_party
andtests
don't contains aCMakeList.txt
file. Ifpf
could generates unit test, it would contains the correspondingCMakeList.txt
file. For the third-party folder, I don't know if add_subdirectory can generate a warning (or if it could test ifthird_party/CMakeList.txt
exists before doingadd_directory
)?
Doc
- I think
pf
shoud ask if you want to create adoc
folder. An empty doc folder will not help anyone ;)
Basic files
- I think that
pf
should create aReadme.md
in the main directory. - Likewise, it should ask witch license you want (with a list of popular licenses) and create the appropriate
LICENCE.txt
file.
Help
-
pf --help
should give a bit more help, or redirect to a more complete webpage. For example I think it should explain how to add an external dependency, or how to create an internal library.
Additional tooling
-
pf
could help setting-up good practice by adding a.clang-format
file, and maybe other tools (like code coverage, version control, …). Feature creep could be a limitation, especially if you want to give choices in the implementation of said tools, but I think it's an option to evaluate.
I know that pf
is still an early work in progress, and I must admit that I think you had an awesome idea when you created it.