search

Azure / azure-sdk-for-cpp

This repository is for active development of the Azure SDK for C++. For consumers of the SDK we recommend visiting our versioned developer docs at https://azure.github.io/azure-sdk-for-cpp.
MIT License
177 stars 127 forks source link

As a Linux contributor, the documentation to get started contributing to the SDK should be easy to follow and complete #5698

Open ahsonkhan opened 3 months ago

ahsonkhan commented 3 months ago

Scenario: Start with a ubuntu wsl instance, follow the steps required to clone and build the SDK repo, and be successful.

The tools and steps needed are not clear, and I had to work through missing details and errors to get the repo building successfully.

I'll share more details of obstacles I observed along the way.

One of the errors was a missing dependency (pkg-config), which I had to get from apt-get, that wasn't specified in either the SDK nor the vcpkg docs.

I have some suggestions on what we can do to improve here.

cc @RickWinter

LarryOsterman commented 3 months ago

Is pkg-config a requirement for vcpkg? I thought it was only a requirement for some of our packages.

And yeah - I went through the same experience yesterday and it was less than ideal.

ahsonkhan commented 3 months ago

Is pkg-config a requirement for vcpkg? I thought it was only a requirement for some of our packages.

I didn't capture all the major and minor pain-points when going through the process, but yes, I was hitting a build error on that dependency (maybe it's transitive?). I lost the exact error after I resolved it because my terminal closed (devbox restarted). I will replicate the process whenever I can find some time, on a fresh instance, and document the concerns I observed.

I wanted to capture the gist of what I saw, while it was fresh, and at least file a tracking issue that this can be improved.

In the meantime, putting on a "new contributor" hat, if Ronnie or others are curious and want to try, from scratch, please feel free and report the documentation gap or build errors you observed.