PointCloudLibrary / PointCloudLibrary/pcl

[docs] Keep track of the minimum supported versions of our dependencies in a centralized location

Open
#4,099 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

kind: proposal module: docs needs: feedback
Dominant language
C++
Stars
11.1k
Forks
4.7k
Avg merge
4d 10h
Merged PRs (30d)
6

Description

Is your feature request related to a problem? Please describe.

Meta problem. Often we rely on maintainers and contributors memory to know what are the current minimum supported versions of PCL's dependencies, be it compilers, tools or 3rd party libs. Each person might know a few but there's always a chance that it is unknown to all.

Context

During an issue discussion or review process it happens frequently that a user/contributor/maintainer will not really be aware what minimum versions PCL is supporting.

Expected behavior

I would like to have all this info centralized somewhere.

Current Behavior

We're relying on everyone's memory. :)

Describe the solution you'd like / alternatives you've considered

A dedicated CMake file - would allow for a nice configuration/substitution directly to the docs and other places in our code. Currently, the integration with tutorials is not really viable because read the docs is using the bare folder without running any configuration.
README.md - easy for users to see but hard to update other places of the source tree which might want to rely on this info

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing README.md, the existing CMake configuration, and how tutorials are published through Read the Docs. Identify where minimum versions for compilers, tools, and third-party libraries are currently specified or assumed. Done means the supported versions have one maintained source and can be reused by documentation or other source-tree locations without requiring the bare Read the Docs folder to be configured.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, cpp
Domain
build-system, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.