PointCloudLibrary / PointCloudLibrary/pcl
Write up PCL versioning policy
Open
Nobody has claimed this yet.
needs: author reply
status: stale
- Dominant language
- C++
- Stars
- 11.1k
- Forks
- 4.7k
- Avg merge
- 4d 10h
- Merged PRs (30d)
- 6
Description
Is PCL following SemVer?
I'd say we loosely follow SemVer. The SemVer rules are:
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards-compatible manner, and
- PATCH version when you make backwards-compatible bug fixes.
On the PCL side we
- Reserve MAJOR for a large library revision.
- Bump MINOR at breaking ABI changes and (in certain cases) API changes
- When API change is minor and (supposedly) shouldn't affect many users or otherwise cause trouble
- When the change is removing APIs deprecated several MINOR revisions before.
- When the change happened by accident ;)
- PATCH is for fully-compatible updates, which occasionally may include new features.
Originally posted by @taketwo in https://github.com/PointCloudLibrary/pcl/issues/2772#issuecomment-458866175
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no file, test, or entry point. Start by locating existing PCL versioning or release documentation, then document the stated comparison with SemVer and PCL’s MAJOR, MINOR, and PATCH policy. Done means the policy is written up and discoverable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100