Contributing

There are many ways to contribute to Hunter:

  • Documentation
  • There is a newer version of an existing package? Notify us or send a pull request with an updated version.
  • Missing a package in Hunter? Add a new package
  • Resolve Issues
    • Can you provide an answer to an open question?
    • Can you reproduce the error?
    • Is the issue still relevant? Maybe the issue can be closed.

When contributing please follow the style guides:

Note

The minimum version of CMake for using Hunter is 3.0. Please check that you’re not using commands from newer versions (see documentation for 3.0).

Note

Before adding or updating a package in Hunter, the package is tested. Tests are done to check if the source can be downloaded, built and linked. Head over to our repository for per package CI testing contribution to see more.

Reporting bugs

Hunter is CMake-based package manager so it’s assumed that CMake is installed and working correctly. Before reporting bugs please check:

  • Appropriate version of CMake is installed. See CMake version for Hunter.

  • Verify CMake, build tools and C/C++ compilers you’re planning to use. Try to build simple CMake project (check this document in case you have troubles):

    # CMakeLists.txt
    
    cmake_minimum_required(VERSION 3.0)
    project(foo)
    
    add_executable(foo foo.cpp)
    
    // foo.cpp
    
    #include <iostream>
    
    int main() {
      std::cout << "Hello world!" << std::endl;
    }
    
  • Most sources downloaded by HTTPS protocol so CMake should be build with CURL with enabled OpenSSL. Without HTTPS support you will see this error:

    error: downloading
    'https://...' failed
    
      status_code: 1
      status_string: "Unsupported protocol"
      log: Protocol "https" not supported or disabled in libcurl
    
    Closing connection -1
    

If everything seems OK:

  • Run build again with HUNTER_STATUS_DEBUG=ON
  • Take a look at first error reported by Hunter. If Hunter reports chain of errors the last error you see is not relevant!
  • Update to latest Hunter URL/SHA1 and check that issue you have hit is not already fixed/reported
  • Open an issue and provide next info:
    • CMake version you’re using cmake --version. CMake build from source?
    • OS (Linux, OSX, Windows)
    • Command line you’re using on generate step (e.g. cmake -H. -B_builds "-GVisual Studio 14 2015")
    • Add log until first error reported by Hunter