Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Declare our public API #248

Open
chapulina opened this issue May 3, 2022 · 0 comments
Open

Declare our public API #248

chapulina opened this issue May 3, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@chapulina
Copy link
Contributor

chapulina commented May 3, 2022

We should formally declare what's part of our public API, so that users are aware of what will be kept stable and what's subject to change without warning or tick-tock.

Take into account:

  • Public headers and what it means if they're in a details folder
  • CMake functions from gz-cmake
  • CLI arguments
  • Binary symbols
  • Protobuf namespaces

A good reference is REP-2004 and the quality declarations of existing packages, like rclcpp.

We could place this documentation in releases together with versioning and deprecation strategies.

@chapulina chapulina added the enhancement New feature or request label May 3, 2022
@osrf-triage osrf-triage added this to Inbox in Core development May 3, 2022
@chapulina chapulina added the documentation Improvements or additions to documentation label May 3, 2022
@chapulina chapulina moved this from Inbox to To do in Core development May 5, 2022
@j-rivero j-rivero removed this from To do in Core development May 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant